Class: Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata

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

Overview

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

Defined Under Namespace

Classes: IndexConfigDelta, TtlConfigDelta

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The time this operation completed. Will be unset if operation still in progress.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

#field ⇒ ::String

Returns The field resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}.

Returns:

  • (::String) —

    The field resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

#index_config_deltas ⇒ ::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>

Returns A list of IndexConfigDelta, which describe the intent of this operation.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

#progress_bytes ⇒ ::Google::Cloud::Firestore::Admin::V1::Progress

Returns The progress, in bytes, of this operation.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

#progress_documents ⇒ ::Google::Cloud::Firestore::Admin::V1::Progress

Returns The progress, in documents, of this operation.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

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

Returns The time this operation started.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

#state ⇒ ::Google::Cloud::Firestore::Admin::V1::OperationState

Returns The state of the operation.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end

#ttl_config_delta ⇒ ::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta

Returns Describes the deltas of TTL configuration.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 84

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

  # Information about an index configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType]
  #     Specifies how the index is changing.
  # @!attribute [rw] index
  #   @return [::Google::Cloud::Firestore::Admin::V1::Index]
  #     The index being changed.
  class IndexConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the index is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The single field index is being added.
      ADD = 1

      # The single field index is being removed.
      REMOVE = 2
    end
  end

  # Information about a TTL configuration change.
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType]
  #     Specifies how the TTL configuration is changing.
  class TtlConfigDelta
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how the TTL config is changing.
    module ChangeType
      # The type of change is not specified or known.
      CHANGE_TYPE_UNSPECIFIED = 0

      # The TTL config is being added.
      ADD = 1

      # The TTL config is being removed.
      REMOVE = 2
    end
  end
end