Class: Google::Longrunning::OperationInfo

Inherits:

Object

Object
Google::Longrunning::OperationInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/longrunning/operations.rb

Overview

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"
  };
}

Instance Attribute Summary collapse

#metadata_type ⇒ ::String
Required.
#response_type ⇒ ::String
Required.

Instance Attribute Details

#metadata_type ⇒ `::String`

Returns 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:

(::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.

# File 'proto_docs/google/longrunning/operations.rb', line 164

class OperationInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#response_type ⇒ `::String`

Returns 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.