blpapi.Operation¶

class blpapi.Operation¶

Defines an operation which can be performed by a Service.

Operation objects are obtained from a Service object. They provide read-only access to the schema of the Operations Request and the schema of the possible response.

description()¶

Returns: a human readable description of this Operation.
Return type: str

getResponseDefinitionAt(position)¶

Parameters: position (int) – Index of the response type
Returns: Object which defines the schema for the response that this Operation delivers.
Return type: SchemaElementDefinition
Raises: Exception – If position >= numResponseDefinitions().

name()¶

Returns: The name of this Operation.
Return type: str

numResponseDefinitions()¶

Returns: The number of the response types that can be returned by this Operation.
Return type: int

requestDefinition()¶

Returns: Object which defines the schema for this Operation.
Return type: SchemaElementDefinition

responseDefinitions()¶

Returns: Iterator over response types that can be returned by this Operation.

Response type is defined by SchemaElementDefinition.