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

Defined Under Namespace

Classes: IndexConfigDelta

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:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
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}



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
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:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
end

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

Returns The progress, in bytes, of this operation.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
end

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

Returns The progress, in documents, of this operation.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
end

#start_time::Google::Protobuf::Timestamp

Returns The time this operation started.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
end

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

Returns The state of the operation.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'proto_docs/google/firestore/admin/v1/operation.rb', line 78

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
end