Class: Google::Longrunning::Operation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/longrunning/operations.rb

Overview

This resource represents a long-running operation that is the result of a network API call.

Instance Attribute Summary collapse

Instance Attribute Details

#done ⇒ ::Boolean

Returns If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Returns:

  • (::Boolean) —

    If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.



57
58
59
60
 
# File 'proto_docs/google/longrunning/operations.rb', line 57

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

#error ⇒ ::Google::Rpc::Status

Returns The error result of the operation in case of failure or cancellation.

Note: The following fields are mutually exclusive: error, response. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Rpc::Status) —

    The error result of the operation in case of failure or cancellation.

    Note: The following fields are mutually exclusive: error, response. If a field in that set is populated, all other fields in the set will automatically be cleared.



57
58
59
60
 
# File 'proto_docs/google/longrunning/operations.rb', line 57

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

#metadata ⇒ ::Google::Protobuf::Any

Returns Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

Returns:

  • (::Google::Protobuf::Any) —

    Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.



57
58
59
60
 
# File 'proto_docs/google/longrunning/operations.rb', line 57

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

#name ⇒ ::String

Returns The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

Returns:

  • (::String) —

    The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.



57
58
59
60
 
# File 'proto_docs/google/longrunning/operations.rb', line 57

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

#response ⇒ ::Google::Protobuf::Any

Returns The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Note: The following fields are mutually exclusive: response, error. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Any) —

    The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

    Note: The following fields are mutually exclusive: response, error. If a field in that set is populated, all other fields in the set will automatically be cleared.



57
58
59
60
 
# File 'proto_docs/google/longrunning/operations.rb', line 57

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