Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig

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

Overview

The index configuration for this field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1IndexConfig

Returns a new instance of GoogleFirestoreAdminV1IndexConfig



1141
1142
1143
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1141

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) 


1115
1116
1117
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1115

def ancestor_field
  @ancestor_field
end

#indexes ⇒ Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index>

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

Returns:



1120
1121
1122
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1120

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) 


1129
1130
1131
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1129

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) 


1138
1139
1140
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1138

def uses_ancestor_config
  @uses_ancestor_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1146
1147
1148
1149
1150
1151
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1146

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