Class: Google::Cloud::Functions::V2::OperationMetadata

Inherits:

Object

• Object
• Google::Cloud::Functions::V2::OperationMetadata

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/functions/v2/functions.rb

Overview

Represents the metadata of the long-running operation.

Instance Attribute Summary

• #api_version ⇒ ::String

  API version used to start the operation.

• #build_name ⇒ ::String

  The build name of the function for create and update operations.

• #cancel_requested ⇒ ::Boolean

  Identifies whether the user has requested cancellation of the operation.

• #create_time ⇒ ::Google::Protobuf::Timestamp

  The time the operation was created.

• #end_time ⇒ ::Google::Protobuf::Timestamp

  The time the operation finished running.

• #operation_type ⇒ ::Google::Cloud::Functions::V2::OperationType

  The operation type.

• #request_resource ⇒ ::Google::Protobuf::Any

  The original request that started the operation.

• #source_token ⇒ ::String

  An identifier for Firebase function sources.

• #stages ⇒ ::Array<::Google::Cloud::Functions::V2::Stage>

  Mechanism for reporting in-progress stages.

• #status_detail ⇒ ::String

  Human-readable status of the operation, if any.

• #target ⇒ ::String

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

• #verb ⇒ ::String

  Name of the verb executed by the operation.

Instance Attribute Details

#api_version ⇒ ::String

Returns API version used to start the operation.

Returns:

• (::String) —

  API version used to start the operation.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#build_name ⇒ ::String

Returns The build name of the function for create and update operations.

Returns:

• (::String) —

  The build name of the function for create and update operations.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#cancel_requested ⇒ ::Boolean

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

Returns:

• (::Boolean) —

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

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The time the operation was created.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time the operation was created.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns The time the operation finished running.

Returns:

• (::Google::Protobuf::Timestamp) —

  The time the operation finished running.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#operation_type ⇒ ::Google::Cloud::Functions::V2::OperationType

Returns The operation type.

Returns:

• (::Google::Cloud::Functions::V2::OperationType) —

  The operation type.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#request_resource ⇒ ::Google::Protobuf::Any

Returns The original request that started the operation.

Returns:

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

  The original request that started the operation.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#source_token ⇒ ::String

Returns An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

Returns:

• (::String) —

  An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#stages ⇒ ::Array<::Google::Cloud::Functions::V2::Stage>

Returns Mechanism for reporting in-progress stages.

Returns:

• (::Array<::Google::Cloud::Functions::V2::Stage>) —

  Mechanism for reporting in-progress stages

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#status_detail ⇒ ::String

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

Returns:

• (::String) —

  Human-readable status of the operation, if any.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#target ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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

#verb ⇒ ::String

Returns Name of the verb executed by the operation.

Returns:

• (::String) —

  Name of the verb executed by the operation.

# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 1007

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