Class: Google::Cloud::Common::OperationMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/common/operation_metadata.rb

Overview

Represents the metadata of the long-running operation.

Instance Attribute Summary collapse

Instance Attribute Details

#api_version ⇒ ::String (readonly)

Returns Output only. API version used to start the operation.

Returns:

  • (::String) —

    Output only. API version used to start the operation.



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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

#cancel_requested ⇒ ::Boolean (readonly)

Returns Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][] of 1, corresponding to Code.CANCELLED.

Returns:

  • (::Boolean) —

    Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][] of 1, corresponding to Code.CANCELLED.



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the operation was created.

Returns:



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the operation finished running.

Returns:



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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

#status_detail ⇒ ::String (readonly)

Returns Output only. Human-readable status of the operation, if any.

Returns:

  • (::String) —

    Output only. Human-readable status of the operation, if any.



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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

#target ⇒ ::String (readonly)

Returns Output only. Server-defined resource path for the target of the operation.

Returns:

  • (::String) —

    Output only. Server-defined resource path for the target of the operation.



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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

#verb ⇒ ::String (readonly)

Returns Output only. Name of the verb executed by the operation.

Returns:

  • (::String) —

    Output only. Name of the verb executed by the operation.



48
49
50
51
 
# File 'proto_docs/google/cloud/common/operation_metadata.rb', line 48

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