Class: Google::Cloud::Datastore::Admin::V1::CommonMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/datastore/admin/v1/datastore_admin.rb

Overview

Metadata common to all Datastore Admin operations.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The time the operation ended, either successfully or otherwise.

Returns:



43
44
45
46
47
48
49
50
51
52
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
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 43

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The various possible states for an ongoing Operation.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # Request is being prepared for processing.
    INITIALIZING = 1

    # Request is actively being processed.
    PROCESSING = 2

    # Request is in the process of being cancelled after user called
    # google.longrunning.Operations.CancelOperation on the operation.
    CANCELLING = 3

    # Request has been processed and is in its finalization stage.
    FINALIZING = 4

    # Request has completed successfully.
    SUCCESSFUL = 5

    # Request has finished being processed, but encountered an error.
    FAILED = 6

    # Request has finished being cancelled after user called
    # google.longrunning.Operations.CancelOperation.
    CANCELLED = 7
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The client-assigned labels which were provided when the operation was created. May also include additional labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The client-assigned labels which were provided when the operation was created. May also include additional labels.



43
44
45
46
47
48
49
50
51
52
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
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 43

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The various possible states for an ongoing Operation.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # Request is being prepared for processing.
    INITIALIZING = 1

    # Request is actively being processed.
    PROCESSING = 2

    # Request is in the process of being cancelled after user called
    # google.longrunning.Operations.CancelOperation on the operation.
    CANCELLING = 3

    # Request has been processed and is in its finalization stage.
    FINALIZING = 4

    # Request has completed successfully.
    SUCCESSFUL = 5

    # Request has finished being processed, but encountered an error.
    FAILED = 6

    # Request has finished being cancelled after user called
    # google.longrunning.Operations.CancelOperation.
    CANCELLED = 7
  end
end

#operation_type ⇒ ::Google::Cloud::Datastore::Admin::V1::OperationType

Returns The type of the operation. Can be used as a filter in ListOperationsRequest.

Returns:



43
44
45
46
47
48
49
50
51
52
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
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 43

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The various possible states for an ongoing Operation.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # Request is being prepared for processing.
    INITIALIZING = 1

    # Request is actively being processed.
    PROCESSING = 2

    # Request is in the process of being cancelled after user called
    # google.longrunning.Operations.CancelOperation on the operation.
    CANCELLING = 3

    # Request has been processed and is in its finalization stage.
    FINALIZING = 4

    # Request has completed successfully.
    SUCCESSFUL = 5

    # Request has finished being processed, but encountered an error.
    FAILED = 6

    # Request has finished being cancelled after user called
    # google.longrunning.Operations.CancelOperation.
    CANCELLED = 7
  end
end

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

Returns The time that work began on the operation.

Returns:



43
44
45
46
47
48
49
50
51
52
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
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 43

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The various possible states for an ongoing Operation.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # Request is being prepared for processing.
    INITIALIZING = 1

    # Request is actively being processed.
    PROCESSING = 2

    # Request is in the process of being cancelled after user called
    # google.longrunning.Operations.CancelOperation on the operation.
    CANCELLING = 3

    # Request has been processed and is in its finalization stage.
    FINALIZING = 4

    # Request has completed successfully.
    SUCCESSFUL = 5

    # Request has finished being processed, but encountered an error.
    FAILED = 6

    # Request has finished being cancelled after user called
    # google.longrunning.Operations.CancelOperation.
    CANCELLED = 7
  end
end

#state ⇒ ::Google::Cloud::Datastore::Admin::V1::CommonMetadata::State

Returns The current state of the Operation.

Returns:



43
44
45
46
47
48
49
50
51
52
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
 
# File 'proto_docs/google/datastore/admin/v1/datastore_admin.rb', line 43

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The various possible states for an ongoing Operation.
  module State
    # Unspecified.
    STATE_UNSPECIFIED = 0

    # Request is being prepared for processing.
    INITIALIZING = 1

    # Request is actively being processed.
    PROCESSING = 2

    # Request is in the process of being cancelled after user called
    # google.longrunning.Operations.CancelOperation on the operation.
    CANCELLING = 3

    # Request has been processed and is in its finalization stage.
    FINALIZING = 4

    # Request has completed successfully.
    SUCCESSFUL = 5

    # Request has finished being processed, but encountered an error.
    FAILED = 6

    # Request has finished being cancelled after user called
    # google.longrunning.Operations.CancelOperation.
    CANCELLED = 7
  end
end