Class: Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1beta2/classes.rb,
generated/google/apis/firestore_v1beta2/representations.rb,
generated/google/apis/firestore_v1beta2/representations.rb

Overview

The index configuration for this field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta2IndexConfig

Returns a new instance of GoogleFirestoreAdminV1beta2IndexConfig.



431
432
433
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 431

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ancestor_field ⇒ String

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

Returns:

  • (String) 


407
408
409
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 407

def ancestor_field
  @ancestor_field
end

#indexes ⇒ Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index>

The indexes supported for this field. Corresponds to the JSON property indexes

Returns:



412
413
414
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 412

def indexes
  @indexes
end

#reverting ⇒ Boolean Also known as: reverting?

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

Returns:

  • (Boolean) 


420
421
422
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 420

def reverting
  @reverting
end

#uses_ancestor_config ⇒ Boolean Also known as: uses_ancestor_config?

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

Returns:

  • (Boolean) 


428
429
430
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 428

def uses_ancestor_config
  @uses_ancestor_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



436
437
438
439
440
441
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 436

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