# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Field::IndexConfig (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.1 0.16.0 0.15.0 0.14.3 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.5 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 (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).

### #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 (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).
**Returns**

- (::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).

### #indexes

    def indexes() -> ::Array<::Google::Cloud::Firestore::Admin::V1::Index>

**Returns**

- (::Array\<[::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index)\>) --- The indexes supported for this field.
**Returns**

- (::Array\<[::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/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 by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.

### #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 by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
**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 by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.

### #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 the `ancestor_field`. When false, the `Field`'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 the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
**Returns**

- (::Boolean) --- 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.