Documentation

OperationInfo extends Message
in package

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

Example: rpc LongRunningRecognize(LongRunningRecognizeRequest) returns (google.longrunning.Operation) { option (google.longrunning.operation_info) = { response_type: "LongRunningRecognizeResponse" metadata_type: "LongRunningRecognizeMetadata" }; }

Generated from protobuf message google.longrunning.OperationInfo

Table of Contents

Properties

$metadata_type  : mixed
Required. The message name of the metadata type for this long-running operation.
$response_type  : mixed
Required. The message name of the primary return type for this long-running operation.

Methods

__construct()  : mixed
Constructor.
getMetadataType()  : string
Required. The message name of the metadata type for this long-running operation.
getResponseType()  : string
Required. The message name of the primary return type for this long-running operation.
setMetadataType()  : $this
Required. The message name of the metadata type for this long-running operation.
setResponseType()  : $this
Required. The message name of the primary return type for this long-running operation.

Properties

$metadata_type

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

protected mixed $metadata_type = ''

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.

Generated from protobuf field string metadata_type = 2 [json_name = "metadataType"];

$response_type

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

protected mixed $response_type = ''

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.

Generated from protobuf field string response_type = 1 [json_name = "responseType"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $response_type
      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.
@type string $metadata_type
      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.

}

getMetadataType()

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

public getMetadataType() : string

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.

Generated from protobuf field string metadata_type = 2 [json_name = "metadataType"];

Return values
string

getResponseType()

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

public getResponseType() : string

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.

Generated from protobuf field string response_type = 1 [json_name = "responseType"];

Return values
string

setMetadataType()

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

public setMetadataType(string $var) : $this

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.

Generated from protobuf field string metadata_type = 2 [json_name = "metadataType"];

Parameters
$var : string
Return values
$this

setResponseType()

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

public setResponseType(string $var) : $this

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.

Generated from protobuf field string response_type = 1 [json_name = "responseType"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results