class Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig

The index configuration for this field.

Attributes

ancestor_field[RW]

Output only. Specifies the resource name of the `Field` from which this field' s index configuration is set (when `uses_ancestor_config` is true), or from which it would be set if this field had no index configuration (when ` uses_ancestor_config` is false). Corresponds to the JSON property `ancestorField` @return [String]

indexes[RW]

The indexes supported for this field. Corresponds to the JSON property `indexes` @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index>]

reverting[RW]

Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point ` uses_ancestor_config` will be `true` and `reverting` will be `false`. Corresponds to the JSON property `reverting` @return [Boolean]

reverting?[RW]

Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point ` uses_ancestor_config` will be `true` and `reverting` will be `false`. Corresponds to the JSON property `reverting` @return [Boolean]

uses_ancestor_config[RW]

Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. Corresponds to the JSON property `usesAncestorConfig` @return [Boolean]

uses_ancestor_config?[RW]

Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly. Corresponds to the JSON property `usesAncestorConfig` @return [Boolean]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/firestore_v1/classes.rb, line 1167
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/firestore_v1/classes.rb, line 1172
def update!(**args)
  @ancestor_field = args[:ancestor_field] if args.key?(:ancestor_field)
  @indexes = args[:indexes] if args.key?(:indexes)
  @reverting = args[:reverting] if args.key?(:reverting)
  @uses_ancestor_config = args[:uses_ancestor_config] if args.key?(:uses_ancestor_config)
end