Class: Google::Cloud::Gaming::V1::OperationMetadata

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

Overview

Represents the metadata of the long-running operation.

Defined Under Namespace

Classes: OperationStatusEntry

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.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. The time the operation was created.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. The time the operation finished running.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#operation_status ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Gaming::V1::OperationStatus} (readonly)

Returns Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Gaming::V1::OperationStatus}) —

    Output only. Operation status for Game Services API operations. Operation status is in the form of key-value pairs where keys are resource IDs and the values show the status of the operation. In case of failures, the value includes an error code and error message.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#requested_cancellation ⇒ ::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.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status_message ⇒ ::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.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#unreachable ⇒ ::Array<::String> (readonly)

Returns Output only. List of Locations that could not be reached.

Returns:

  • (::Array<::String>) —

    Output only. List of Locations that could not be reached.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/gaming/v1/common.rb', line 58

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Gaming::V1::OperationStatus]
  class OperationStatusEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end