Google LongRunning Client - Class OperationInfo (0.4.6)

Reference documentation and code samples for the Google LongRunning Client class OperationInfo.

A message representing the message types used by a long-running operation.

Example: rpc Export(ExportRequest) returns (google.longrunning.Operation) { option (google.longrunning.operation_info) = { response_type: "ExportResponse" metadata_type: "ExportMetadata" }; }

Generated from protobuf message google.longrunning.OperationInfo

Namespace

Google \ LongRunning

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ response_type string

Required. The message name of the primary return type for this long-running operation. This type will be used to deserialize the LRO's response. If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct). Note: Altering this value constitutes a breaking change.
↳ metadata_type string

Required. The message name of the metadata type for this long-running operation. If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct). Note: Altering this value constitutes a breaking change.

getResponseType

Required. The message name of the primary return type for this long-running operation.

This type will be used to deserialize the LRO's response. If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct). Note: Altering this value constitutes a breaking change.

Returns
Type Description
string

setResponseType

Required. The message name of the primary return type for this long-running operation.

This type will be used to deserialize the LRO's response. If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct). Note: Altering this value constitutes a breaking change.

Parameter
Name Description
var string
Returns
Type Description
$this

getMetadataType

Required. The message name of the metadata type for this long-running operation.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct). Note: Altering this value constitutes a breaking change.

Returns
Type Description
string

setMetadataType

Required. The message name of the metadata type for this long-running operation.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct). Note: Altering this value constitutes a breaking change.

Parameter
Name Description
var string
Returns
Type Description
$this