Document AI V1beta3 API - Class Google::Longrunning::OperationInfo (v0.43.1)

Reference documentation and code samples for the Document AI V1beta3 API class Google::Longrunning::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"
  };
}

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#metadata_type

def metadata_type() -> ::String
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.

#metadata_type=

def metadata_type=(value) -> ::String
Parameter
  • value (::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.

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.

#response_type

def response_type() -> ::String
Returns
  • (::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.

#response_type=

def response_type=(value) -> ::String
Parameter
  • value (::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.

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