Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Field::IndexConfig.
The index configuration for this field.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ancestor_field
def ancestor_field() -> ::String
Returns
-
(::String) — Output only. Specifies the resource name of the
Field
from which this field's index configuration is set (whenuses_ancestor_config
is true), or from which it would be set if this field had no index configuration (whenuses_ancestor_config
is false).
#ancestor_field=
def ancestor_field=(value) -> ::String
Parameter
-
value (::String) — Output only. Specifies the resource name of the
Field
from which this field's index configuration is set (whenuses_ancestor_config
is true), or from which it would be set if this field had no index configuration (whenuses_ancestor_config
is false).
Returns
-
(::String) — Output only. Specifies the resource name of the
Field
from which this field's index configuration is set (whenuses_ancestor_config
is true), or from which it would be set if this field had no index configuration (whenuses_ancestor_config
is false).
#indexes
def indexes() -> ::Array<::Google::Cloud::Firestore::Admin::V1::Index>
Returns
- (::Array<::Google::Cloud::Firestore::Admin::V1::Index>) — The indexes supported for this field.
#indexes=
def indexes=(value) -> ::Array<::Google::Cloud::Firestore::Admin::V1::Index>
Parameter
- value (::Array<::Google::Cloud::Firestore::Admin::V1::Index>) — The indexes supported for this field.
Returns
- (::Array<::Google::Cloud::Firestore::Admin::V1::Index>) — The indexes supported for this field.
#reverting
def reverting() -> ::Boolean
Returns
-
(::Boolean) — 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 byancestor_field
, at which pointuses_ancestor_config
will betrue
andreverting
will befalse
.
#reverting=
def reverting=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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 byancestor_field
, at which pointuses_ancestor_config
will betrue
andreverting
will befalse
.
Returns
-
(::Boolean) — 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 byancestor_field
, at which pointuses_ancestor_config
will betrue
andreverting
will befalse
.
#uses_ancestor_config
def uses_ancestor_config() -> ::Boolean
Returns
-
(::Boolean) — Output only. When true, the
Field
's index configuration is set from the configuration specified by theancestor_field
. When false, theField
's index configuration is defined explicitly.
#uses_ancestor_config=
def uses_ancestor_config=(value) -> ::Boolean
Parameter
-
value (::Boolean) — Output only. When true, the
Field
's index configuration is set from the configuration specified by theancestor_field
. When false, theField
's index configuration is defined explicitly.
Returns
-
(::Boolean) — Output only. When true, the
Field
's index configuration is set from the configuration specified by theancestor_field
. When false, theField
's index configuration is defined explicitly.