# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Field (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.

Represents a single field in the database.


<br />

Fields are grouped by their "Collection Group", which represent all
collections in the database with the same ID.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #index_config

    def index_config() -> ::Google::Cloud::Firestore::Admin::V1::Field::IndexConfig

**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Field::IndexConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field-IndexConfig)) --- The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.

### #index_config=

    def index_config=(value) -> ::Google::Cloud::Firestore::Admin::V1::Field::IndexConfig

**Parameter**

- **value** ([::Google::Cloud::Firestore::Admin::V1::Field::IndexConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field-IndexConfig)) --- The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Field::IndexConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field-IndexConfig)) --- The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`


  A field path can be a simple field name, e.g. `address` or a path to fields
  within `map_value` , e.g. `address.city`,
  or a special field path. The only valid special field is `*`, which
  represents any field.

  Field paths can be quoted using `` ` `` (backtick). The only character that
  must be escaped within a quoted field path is the backtick character
  itself, escaped using a backslash. Special characters in field paths that
  must be quoted include: `*`, `.`,
  `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.

  Examples:
  `` `address.city` `` represents a field named `address.city`, not the map
  key `city` in the field `address`. `` `*` `` represents a field named `*`,
  not any field.

  A special `Field` contains the default indexing settings for all fields.
  This field's resource name is:
  `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
  Indexes defined on this `Field` will be applied to all fields which do not
  have their own `Field` index configuration.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`


  A field path can be a simple field name, e.g. `address` or a path to fields
  within `map_value` , e.g. `address.city`,
  or a special field path. The only valid special field is `*`, which
  represents any field.

  Field paths can be quoted using `` ` `` (backtick). The only character that
  must be escaped within a quoted field path is the backtick character
  itself, escaped using a backslash. Special characters in field paths that
  must be quoted include: `*`, `.`,
  `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.

  Examples:
  `` `address.city` `` represents a field named `address.city`, not the map
  key `city` in the field `address`. `` `*` `` represents a field named `*`,
  not any field.

  A special `Field` contains the default indexing settings for all fields.
  This field's resource name is:
  `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
  Indexes defined on this `Field` will be applied to all fields which do not
  have their own `Field` index configuration.
**Returns**

- (::String) --- Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`


  A field path can be a simple field name, e.g. `address` or a path to fields
  within `map_value` , e.g. `address.city`,
  or a special field path. The only valid special field is `*`, which
  represents any field.

  Field paths can be quoted using `` ` `` (backtick). The only character that
  must be escaped within a quoted field path is the backtick character
  itself, escaped using a backslash. Special characters in field paths that
  must be quoted include: `*`, `.`,
  `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.

  Examples:
  `` `address.city` `` represents a field named `address.city`, not the map
  key `city` in the field `address`. `` `*` `` represents a field named `*`,
  not any field.

  A special `Field` contains the default indexing settings for all fields.
  This field's resource name is:
  `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
  Indexes defined on this `Field` will be applied to all fields which do not
  have their own `Field` index configuration.

### #ttl_config

    def ttl_config() -> ::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig

**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field-TtlConfig)) --- The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`.

### #ttl_config=

    def ttl_config=(value) -> ::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig

**Parameter**

- **value** ([::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field-TtlConfig)) --- The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`.
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field-TtlConfig)) --- The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`.