Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig
- 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
-
#ancestor_field ⇒ String
Output only.
-
#indexes ⇒ Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index>
The indexes supported for this field.
-
#reverting ⇒ Boolean
(also: #reverting?)
Output only When true, the
Field
's index configuration is in the process of being reverted. -
#uses_ancestor_config ⇒ Boolean
(also: #uses_ancestor_config?)
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleFirestoreAdminV1IndexConfig
constructor
A new instance of GoogleFirestoreAdminV1IndexConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleFirestoreAdminV1IndexConfig
Returns a new instance of GoogleFirestoreAdminV1IndexConfig
1159 1160 1161 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 1159 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
1133 1134 1135 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 1133 def ancestor_field @ancestor_field end |
#indexes ⇒ Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index>
The indexes supported for this field.
Corresponds to the JSON property indexes
1138 1139 1140 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 1138 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
1147 1148 1149 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 1147 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
1156 1157 1158 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 1156 def uses_ancestor_config @uses_ancestor_config end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1164 1165 1166 1167 1168 1169 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 1164 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 |