ObjectModel#

Generated reference

Source file:: ansys/api/fluent/v1/object_model.proto
Proto package:: ansys.api.fluent.v1.object_model
Contains:: 1 service, 58 messages, 2 enums

Services

Service: ObjectModel

ObjectModel service provides a way to access some Fluent features like meshing, workflow, preferences, and other specific areas. The rules string in each request selects the target feature area. Supported rules contexts are:

meshing_workflow: The most up-to-date, intuitive exposure of meshing workflow.
meshing_utilities: Meshing queries and other utilities.
solver_workflow: Solver workflows.
preferences: Fluent preferences in both meshing and solution mode.
workflow: Legacy exposure of the workflow component of meshing workflow.
meshing: Legacy exposure of the meshing component of meshing workflow.
part_management: Legacy exposure of the part management component of meshing workflow.
pm_file_management: Legacy exposure of the part management - file-management component of meshing workflow.

Note: StreamStateChanges is not supported for the “meshing_workflow” context.

StreamStateChanges

Request:: StreamStateChangesRequest
Response:: stream of StreamStateChangesResponse

Streams state changes and events. This method is not supported for the “meshing_workflow” rules context.

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.

UpdateDict

Request:: UpdateDictRequest
Response:: UpdateDictResponse

Merges a dictionary of values into the state at the specified path.

CreateObject

Request:: CreateObjectRequest
Response:: CreateObjectResponse

Creates a new named object at the specified path.

DeleteObject

Request:: DeleteObjectRequest
Response:: DeleteObjectResponse

Deletes the object at the specified path.

GetAttributeValue

Request:: GetAttributeValueRequest
Response:: GetAttributeValueResponse

Returns the value of a named attribute for the object at the specified path.

ExecuteCommand

Request:: ExecuteCommandRequest
Response:: ExecuteCommandResponse

Executes a command on the object at the specified path.

ExecuteQuery

Request:: ExecuteQueryRequest
Response:: ExecuteQueryResponse

Executes a query on the object at the specified path and returns the result.

CreateCommandArguments

Request:: CreateCommandArgumentsRequest
Response:: CreateCommandArgumentsResponse

Creates a command arguments object for the specified command.

DeleteCommandArguments

Request:: DeleteCommandArgumentsRequest
Response:: DeleteCommandArgumentsResponse

Deletes a created command arguments object.

GetSchema

Request:: GetSchemaRequest
Response:: GetSchemaResponse

Returns the API schema describing the structure of the object model.

Rename

Request:: RenameRequest
Response:: RenameResponse

Renames the object at the specified path.

FixState

Request:: FixStateRequest
Response:: FixStateResponse

Fixes the state of the object at the specified path to ensure internal consistency.

GetObjectNames

Request:: GetObjectNamesRequest
Response:: GetObjectNamesResponse

Returns the names of all objects at the specified path.

DeleteChildObjects

Request:: DeleteChildObjectsRequest
Response:: DeleteChildObjectsResponse

Deletes all child objects of the parent object at the specified path.

SubscribeEvents

Request:: SubscribeEventsRequest
Response:: SubscribeEventsResponse

Subscribes to one or more events.

UnsubscribeEvents

Request:: UnsubscribeEventsRequest
Response:: UnsubscribeEventsResponse

Unsubscribes from subscribed events.

StreamEvents

Request:: StreamEventsRequest
Response:: stream of StreamEventsResponse

Streams subscribed events.

Messages

StreamStateChangesRequest

StreamStateChangesRequest is the request message for initiating state streaming

rules (1)string: The rules context for the streaming operation
return_state_changes (2)bool: If true, returns state changes in the stream.
diff_state (3)DiffState: The level of detail for state differences

StreamStateChangesResponse

StreamStateChangesResponse is the streaming response containing state updates

state (1)Variant: The current state or state changes
deleted_paths (2)repeated string: Paths of deleted objects
events (3)repeated string: Events that occurred

GetStateRequest

GetStateRequest is the request message for retrieving state

rules (1)string: The rules context for the state query
path (2)string: The path to retrieve state from

GetStateResponse

GetStateResponse is the response message containing the requested state

state (1)Variant: The state at the requested path

SetStateRequest

SetStateRequest is the request message for setting state

rules (1)string: The rules context for the state update
path (2)string: The path where state should be set
state (3)Variant: The new state to set
wait (4)bool: If true, waits for the operation to complete before returning.

SetStateResponse

SetStateResponse is the response message containing the updated state

state (1)Variant: The updated state after the operation
deleted_paths (2)repeated string: Paths of deleted objects

UpdateDictRequest

UpdateDictRequest is the request message for updating a dictionary

rules (1)string: The rules context for the update
path (2)string: The path to the dictionary to update
merge_dict (3)Variant: The dictionary values to merge
wait (4)bool: If true, waits for the operation to complete before returning.
recursive (5)bool: If true, updates recursively.

UpdateDictResponse

UpdateDictResponse is the response message containing the updated state

state (1)Variant: The updated state after the dictionary merge
deleted_paths (2)repeated string: Paths of deleted objects

CreateObjectRequest

CreateObjectRequest is the request message for creating a new named object

rules (1)string: The rules context for the creation
path (2)string: The path to the parent object
name (3)string: The name of the new object to create
wait (4)bool: If true, waits for the operation to complete before returning.

CreateObjectResponse

CreateObjectResponse is the response message after creating a new named object

state (1)Variant: The updated state after creation
deleted_paths (2)repeated string: Paths of deleted objects

DeleteObjectRequest

DeleteObjectRequest is the request message for deleting an object

rules (1)string: The rules context for the deletion
path (2)string: The path to the object to delete
wait (3)bool: If true, waits for the operation to complete before returning.

DeleteObjectResponse

DeleteObjectResponse is the response message after deleting an object

state (1)Variant: The updated state after deletion
deleted_paths (2)repeated string: Paths of deleted objects

GetAttributeValueRequest

GetAttributeValueRequest is the request message for retrieving an attribute value

rules (1)string: The rules context for the attribute query
path (2)string: The path to the object
attribute (3)string: The name of the attribute to retrieve

GetAttributeValueResponse

GetAttributeValueResponse is the response message containing the attribute value

result (1)Variant: The value of the requested attribute

ExecuteCommandRequest

ExecuteCommandRequest is the request message for executing a command

rules (1)string: The rules context for command execution
path (2)string: The path to the object with the command
command (3)string: The name of the command to execute
wait (4)bool: If true, waits for the command to complete before returning.
args (5)Variant: Arguments to pass to the command

ExecuteCommandResponse

ExecuteCommandResponse is the response message containing command execution results

result (1)Variant: The return value from the command
state (2)Variant: The updated state after command execution
deleted_paths (3)repeated string: Paths of deleted objects

ExecuteQueryRequest

ExecuteQueryRequest is the request message for executing a query

rules (1)string: The rules context for query execution
path (2)string: The path to the object with the query
query (3)string: The name of the query to execute
args (4)Variant: Arguments to pass to the query

ExecuteQueryResponse

ExecuteQueryResponse is the response message containing query execution results

result (1)Variant: The return value from the query

CreateCommandArgumentsRequest

CreateCommandArgumentsRequest is the request message for creating command arguments

rules (1)string: The rules context for the operation
path (2)string: The path to the object with the command
command (3)string: The name of the command

CreateCommandArgumentsResponse

CreateCommandArgumentsResponse is the response message containing the command ID

command_id (1)string: The unique identifier for the created command arguments

DeleteCommandArgumentsRequest

DeleteCommandArgumentsRequest is the request message for deleting command arguments

rules (1)string: The rules context for the operation
path (2)string: The path to the object with the command
command (3)string: The name of the command
command_id (4)string: The unique identifier of the command arguments to delete

DeleteCommandArgumentsResponse

DeleteCommandArgumentsResponse is the response message for a delete command arguments operation

CommandArg

CommandArg contains information about a command argument

type (1)string: The type of the argument
name (2)string: The name of the argument
info (3)Schema: The schema information for this argument.
help_string (4)string: Help text for the argument
attrs (5)repeated AttrsEntry: Additional attributes for the argument
doc_string (6)string: Documentation string for the argument

CommandInfo

CommandInfo contains information about a command or query

return_type (1)string: The return type of the command
args (2)repeated CommandArg: The arguments for the command
doc_string (3)string: Documentation string for the command

Schema

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

named_objects (1)repeated NamedObjectsEntry: Named objects within this object
singletons (2)repeated SingletonsEntry: Singleton objects within this object
parameters (3)repeated ParametersEntry: Parameters within this object
commands (4)repeated CommandsEntry: Commands available for this object
type (5)string: The type of this object
command_info (6)CommandInfo: Information about the command (if this is a command)
queries (7)repeated QueriesEntry: Queries available for this object
query_info (8)CommandInfo: Information about the query (if this is a query)
help_string (9)string: Help text for this object
attrs (10)repeated AttrsEntry: Additional attributes for this object

GetSchemaRequest

GetSchemaRequest is the request message for GetSchema.

rules (1)string: The rules context for the schema query.

GetSchemaResponse

GetSchemaResponse is the response message for GetSchema.

info (1)Schema: The API schema for the object model.

CreatedEventRequest

CreatedEventRequest is used to subscribe to object creation events

parent_path (1)string: parent-path of the created object
child_type (2)string: type of the created object

ModifiedEventRequest

ModifiedEventRequest is used to subscribe to object modification events

path (1)string: path of the modified object

DeletedEventRequest

DeletedEventRequest is used to subscribe to object deletion events

path (1)string: path of the deleted object

AffectedEventRequest

AffectedEventRequest is used to subscribe to object affected events

path (1)string: path of the affected object
subtype (2)string: subtype of the affected event

AttributeChangedEventRequest

AttributeChangedEventRequest is used to subscribe to attribute change events

path (1)string: path of the object whose attribute is changed
attribute (2)string: name of the attribute

CommandAttributeChangedEventRequest

CommandAttributeChangedEventRequest is used to subscribe to command attribute change events

path (1)string: path of the object whose command attribute is changed
command (2)string: name of the command
attribute (3)string: name of the attribute

CommandExecutedEventRequest

CommandExecutedEventRequest is used to subscribe to command execution events

path (1)string: path of the object with the command
command (2)string: name of the command, deprecated since Fluent 2025 R2

ObjectModelEventRequest

ObjectModelEventRequest is a request to subscribe to specific events

rules (1)string: The rules context for the event subscription
created_event_request (2)oneof event_request CreatedEventRequest: Subscribe to creation events
modified_event_request (3)oneof event_request ModifiedEventRequest: Subscribe to modification events
deleted_event_request (4)oneof event_request DeletedEventRequest: Subscribe to deletion events
affected_event_request (5)oneof event_request AffectedEventRequest: Subscribe to affected events
attribute_changed_event_request (6)oneof event_request AttributeChangedEventRequest: Subscribe to attribute change events
command_attribute_changed_event_request (7)oneof event_request CommandAttributeChangedEventRequest: Subscribe to command attribute change events
command_executed_event_request (8)oneof event_request CommandExecutedEventRequest: Subscribe to command execution events

SubscribeEventsRequest

SubscribeEventsRequest is the request message for subscribing to events

event_requests (1)repeated ObjectModelEventRequest: The list of event subscriptions to register

EventSubscription

EventSubscription contains information about a subscribed event

tag (1)string: tag is used to identify a subscribed event in server. A subscribed event can later be unsubscribed. Unique identifier for the subscription
status (2)SubscriptionStatus: The status of the subscription

SubscribeEventsResponse

SubscribeEventsResponse is the response message containing subscription status

responses (1)repeated EventSubscription: The list of event subscriptions with their status

UnsubscribeEventsRequest

UnsubscribeEventsRequest is the request message for unsubscribing from events

tags (1)repeated string: The list of subscription tags to unsubscribe

UnsubscribeEventsResponse

UnsubscribeEventsResponse is the response message containing unsubscription status

responses (1)repeated EventSubscription: The list of unsubscribed events with their status

StreamEventsRequest

StreamEventsRequest is the request message for starting event streaming

CreatedEventResponse

CreatedEventResponse is the response message for object creation events

parent_path (1)string: parent-path of the created object
child_type (2)string: type of the created object
child_name (3)string: name of the created object

ModifiedEventResponse

ModifiedEventResponse is the response message for object modification events

path (1)string: path of the modified object
value (2)Variant: value of the modified object

DeletedEventResponse

DeletedEventResponse is the response message for object deletion events

path (1)string: path of the deleted object

AffectedEventResponse

AffectedEventResponse is the response message for object affected events

path (1)string: path of the affected object
subtype (2)string: subtype of the affected event

AttributeChangedEventResponse

AttributeChangedEventResponse is the response message for attribute change events

path (1)string: path of the object whose attribute is changed
attribute (2)string: name of the attribute
value (3)Variant: value of the attribute

CommandAttributeChangedEventResponse

CommandAttributeChangedEventResponse is the response message for command attribute change events

path (1)string: path of the object whose command attribute is changed
command (2)string: name of the command
attribute (3)string: name of the attribute
value (4)Variant: value of the attribute

CommandExecutedEventResponse

CommandExecutedEventResponse is the response message for command execution events

path (1)string: path of the object with the command
command (2)string: name of the command
args (3)Variant: command arguments

StreamEventsResponse

StreamEventsResponse is the streaming response containing events

tag (1)string: The tag identifying the subscription that generated this event
rules (2)string: The rules context for the event
created_event_response (3)oneof event_response CreatedEventResponse: Object creation event
modified_event_response (4)oneof event_response ModifiedEventResponse: Object modification event
deleted_event_response (5)oneof event_response DeletedEventResponse: Object deletion event
affected_event_response (6)oneof event_response AffectedEventResponse: Object affected event
attribute_changed_event_response (7)oneof event_response AttributeChangedEventResponse: Attribute change event
command_attribute_changed_event_response (8)oneof event_response CommandAttributeChangedEventResponse: Command attribute change event
command_executed_event_response (9)oneof event_response CommandExecutedEventResponse: Command execution event

RenameRequest

RenameRequest is the request message for renaming an object

rules (1)string: The rules context for the rename operation
path (2)string: The path to the object to rename
new_name (3)string: The new name for the object
wait (4)bool: If true, waits for the operation to complete before returning.

RenameResponse

RenameResponse is the response message after renaming an object

state (1)Variant: The updated state after the rename
deleted_paths (2)repeated string: Paths of deleted objects

GetObjectNamesRequest

GetObjectNamesRequest is the request message for retrieving object names

rules (1)string: The rules context for the query
path (2)string: The path to retrieve object names from

GetObjectNamesResponse

GetObjectNamesResponse is the response message containing object names

names (1)repeated string: The list of object names at the specified path

ChildNames

ChildNames contains a list of child object names

names (1)repeated string: The list of child names

DeleteChildObjectsRequest

DeleteChildObjectsRequest is the request message for deleting child objects

rules (1)string: The rules context for the deletion
path (2)string: The path to the parent object
child_names (3)oneof var ChildNames: Specific child names to delete
delete_all (4)oneof var bool: If true, deletes all child objects.
wait (5)bool: If true, waits for the operation to complete before returning.

DeleteChildObjectsResponse

DeleteChildObjectsResponse is the response message after deleting child objects

state (1)Variant: The updated state after deletion
deleted_paths (2)repeated string: Paths of deleted objects

FixStateRequest

FixStateRequest is the request message for fixing the state of an object

rules (1)string: The rules context for the fix operation
path (2)string: The path to the object to fix

FixStateResponse

FixStateResponse is the response message after fixing state

state (1)Variant: The fixed state
deleted_paths (2)repeated string: Paths of deleted objects during fix

Enumerations

DiffState (enum)

DiffState specifies the level of detail for state differences

DIFF_STATE_UNSPECIFIED (0): Unspecified diff state
DIFF_STATE_FULL (1): Full state including commands
DIFF_STATE_NOCOMMANDS (2): State without commands

SubscriptionStatus (enum)

SubscriptionStatus indicates the status of an event subscription

SUBSCRIPTION_STATUS_UNSPECIFIED (0): Unspecified subscription status
SUBSCRIPTION_STATUS_SUBSCRIBED (1): Successfully subscribed
SUBSCRIPTION_STATUS_UNSUBSCRIBED (2): Successfully unsubscribed