TextInterface#

Generated reference

Source file:: ansys/api/fluent/v1/text_interface.proto
Proto package:: ansys.api.fluent.v1.text_interface
Contains:: 1 service, 18 messages, 1 enum

Services

Service: TextInterface

TextInterface service provides methods for interacting with the Fluent TUI datamodel.

NotifyChanges

Request:: NotifyChangesRequest
Response:: stream of NotifyChangesResponse

Subscribes to changes for one or more paths. The server streams notifications as changes occur.

GetAttributeValue

Request:: GetAttributeValueRequest
Response:: GetAttributeValueResponse

Returns a specific attribute value for an object identified by path.

GetState

Request:: GetStateRequest
Response:: GetStateResponse

Returns the current state at the specified path.

SetState

Request:: SetStateRequest
Response:: SetStateResponse

Sets the state at the specified path.

ExecuteCommand

Request:: ExecuteCommandRequest
Response:: ExecuteCommandResponse

Executes a command under the specified path.

ExecuteQuery

Request:: ExecuteQueryRequest
Response:: ExecuteQueryResponse

Executes a query under the specified path.

CompositeGet

Request:: CompositeGetRequest
Response:: CompositeGetResponse

Batches multiple getters into a single request.

GetSchema

Request:: GetSchemaRequest
Response:: GetSchemaResponse

Retrieves schema information under the specified path.

Messages

NotifyChangesRequest

Request to subscribe to change notifications for one or more paths.

paths (1)Value: One or more paths to subscribe to. Typically an array value; the precise structure is server-defined.
args (2)Struct: Optional subscription arguments (server-defined).

NotifyChangesResponse

Streamed change notification message produced by NotifyChanges.

changed_paths (1)Value: Paths that changed since the last notification.
state_difference (2)Value: Difference payload describing the updates (server-defined structure).

GetAttributeValueRequest

Request to retrieve a specific attribute value for a node.

path (1)string: Datamodel node path.
attribute (2)Attribute: Attribute to retrieve.
args (3)Struct: Optional arguments for the attribute evaluation (server-defined).

GetAttributeValueResponse

Response containing the requested attribute value.

value (1)Value: Retrieved attribute value.

GetStateRequest

Request to retrieve current state at a node.

path (1)string: Datamodel node path.

GetStateResponse

Response containing current state.

state (1)Value: Current state at the path.

SetStateRequest

Request to set state at a node.

path (1)string: Datamodel node path.
state (2)Value: State to apply.

SetStateResponse

Response containing state after setting.

state (1)Value: State after applying the update (may reflect server-side normalization).

ExecuteCommandRequest

Request to execute a command under a node.

path (1)string: Datamodel node path.
command (2)string: Command name to execute.
args (3)Struct: Optional command arguments (server-defined).

ExecuteCommandResponse

Response containing the command result.

result (1)Value: Command execution result.

ExecuteQueryRequest

Request to execute a query under a node.

path (1)string: Datamodel node path.

ExecuteQueryResponse

Response containing the query result.

result (1)Value: Query result.

CompositeGetRequest

Request to execute multiple getter operations in one call.

getters (1)repeated DataModelGetter: Getter requests to execute.

DataModelGetter

A single getter operation used by CompositeGet.

get_attribute_value_request (1)oneof request GetAttributeValueRequest: Attribute value getter request.
get_state_request (2)oneof request GetStateRequest: State getter request.

CompositeGetResponse

Response for CompositeGet.

response (1)Value: Composite response payload corresponding to the getters. The structure is server-defined.

GetSchemaRequest

Request to retrieve static (schema-like) info for a node.

path (1)string: Datamodel node path.

Schema

Schema contains the static API description of objects, including types, parameters, commands, and queries.

menus (1)repeated MenusEntry: Child menus available under this node.
commands (2)repeated CommandsEntry: Commands available under this node.
help (5)string: Human-readable help for this node. Field number 5 is preserved for backward compatibility.

GetSchemaResponse

Response for GetSchema.

info (1)Schema: Schema information for the requested path.

Enumerations

Attribute (enum)

Common attributes that can be queried for a given datamodel node.

ATTRIBUTE_UNSPECIFIED (0): Default value. Do not use.
ATTRIBUTE_CHILD_NAMES (1): Static attributes Names of direct child nodes.
ATTRIBUTE_DATA_TYPE (2): Datamodel value type for this node.
ATTRIBUTE_EXPOSURE_LEVEL (3): Exposure/visibility level for this node.
ATTRIBUTE_DISPLAY_TEXT (4): Human-readable display label.
ATTRIBUTE_QUANTITY_TYPE (5): Quantity/units semantic type.
ATTRIBUTE_HELP_STRING (6): Help text describing this node.
ATTRIBUTE_DEFAULT (100): Dynamic attributes Default value.
ATTRIBUTE_ALLOWED_VALUES (101): Allowed values or value set.
ATTRIBUTE_MINIMUM (102): Minimum allowed numeric value.
ATTRIBUTE_MAXIMUM (103): Maximum allowed numeric value.
ATTRIBUTE_IS_ACTIVE (104): Whether the node is currently active.
ATTRIBUTE_IS_READ_ONLY (105): Whether the node is currently read-only.
ATTRIBUTE_OBJECT_NAMES (106): Names of objects represented under this node.
ATTRIBUTE_CONSTRAINTS (200): Composite attributes Constraints metadata.
ATTRIBUTE_STATIC_ATTRIBUTES (201): Collection of static attributes.
ATTRIBUTE_UI_ATTRIBUTES (202): UI-related attributes.
ATTRIBUTE_CUSTOM (300): Custom attribute Server-defined/custom attribute payload.