Class: Google::Cloud::ServiceManagement::V1::OperationMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/servicemanagement/v1/resources.rb

Overview

The metadata associated with a long running operation resource.

Defined Under Namespace

Modules: Status Classes: Step

Instance Attribute Summary collapse

Instance Attribute Details

#progress_percentage ⇒ ::Integer

Returns Percentage of completion of this operation, ranging from 0 to 100.

Returns:

  • (::Integer) —

    Percentage of completion of this operation, ranging from 0 to 100.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 53

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

  # Represents the status of one operation step.
  # @!attribute [rw] description
  #   @return [::String]
  #     The short description of the step.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::ServiceManagement::V1::OperationMetadata::Status]
  #     The status code.
  class Step
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Code describes the status of the operation (or one of its steps).
  module Status
    # Unspecifed code.
    STATUS_UNSPECIFIED = 0

    # The operation or step has completed without errors.
    DONE = 1

    # The operation or step has not started yet.
    NOT_STARTED = 2

    # The operation or step is in progress.
    IN_PROGRESS = 3

    # The operation or step has completed with errors. If the operation is
    # rollbackable, the rollback completed with errors too.
    FAILED = 4

    # The operation or step has completed with cancellation.
    CANCELLED = 5
  end
end

#resource_names ⇒ ::Array<::String>

Returns The full name of the resources that this operation is directly associated with.

Returns:

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

    The full name of the resources that this operation is directly associated with.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 53

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

  # Represents the status of one operation step.
  # @!attribute [rw] description
  #   @return [::String]
  #     The short description of the step.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::ServiceManagement::V1::OperationMetadata::Status]
  #     The status code.
  class Step
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Code describes the status of the operation (or one of its steps).
  module Status
    # Unspecifed code.
    STATUS_UNSPECIFIED = 0

    # The operation or step has completed without errors.
    DONE = 1

    # The operation or step has not started yet.
    NOT_STARTED = 2

    # The operation or step is in progress.
    IN_PROGRESS = 3

    # The operation or step has completed with errors. If the operation is
    # rollbackable, the rollback completed with errors too.
    FAILED = 4

    # The operation or step has completed with cancellation.
    CANCELLED = 5
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns The start time of the operation.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 53

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

  # Represents the status of one operation step.
  # @!attribute [rw] description
  #   @return [::String]
  #     The short description of the step.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::ServiceManagement::V1::OperationMetadata::Status]
  #     The status code.
  class Step
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Code describes the status of the operation (or one of its steps).
  module Status
    # Unspecifed code.
    STATUS_UNSPECIFIED = 0

    # The operation or step has completed without errors.
    DONE = 1

    # The operation or step has not started yet.
    NOT_STARTED = 2

    # The operation or step is in progress.
    IN_PROGRESS = 3

    # The operation or step has completed with errors. If the operation is
    # rollbackable, the rollback completed with errors too.
    FAILED = 4

    # The operation or step has completed with cancellation.
    CANCELLED = 5
  end
end

#steps ⇒ ::Array<::Google::Cloud::ServiceManagement::V1::OperationMetadata::Step>

Returns Detailed status information for each step. The order is undetermined.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'proto_docs/google/api/servicemanagement/v1/resources.rb', line 53

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

  # Represents the status of one operation step.
  # @!attribute [rw] description
  #   @return [::String]
  #     The short description of the step.
  # @!attribute [rw] status
  #   @return [::Google::Cloud::ServiceManagement::V1::OperationMetadata::Status]
  #     The status code.
  class Step
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Code describes the status of the operation (or one of its steps).
  module Status
    # Unspecifed code.
    STATUS_UNSPECIFIED = 0

    # The operation or step has completed without errors.
    DONE = 1

    # The operation or step has not started yet.
    NOT_STARTED = 2

    # The operation or step is in progress.
    IN_PROGRESS = 3

    # The operation or step has completed with errors. If the operation is
    # rollbackable, the rollback completed with errors too.
    FAILED = 4

    # The operation or step has completed with cancellation.
    CANCELLED = 5
  end
end