public interface FieldOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getIndexConfig()
public abstract Field.IndexConfig getIndexConfig() 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.
.google.firestore.admin.v1.Field.IndexConfig index_config = 2;
| Returns | |
|---|---|
| Type | Description |
Field.IndexConfig |
The indexConfig. |
getIndexConfigOrBuilder()
public abstract Field.IndexConfigOrBuilder getIndexConfigOrBuilder() 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.
.google.firestore.admin.v1.Field.IndexConfig index_config = 2;
| Returns | |
|---|---|
| Type | Description |
Field.IndexConfigOrBuilder |
|
getName()
public abstract String getName() Required. A field name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may 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 may be quoted using (backtick). The only character that needs
to 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:
(Note: Comments here are written in markdown syntax, so there is an
additional layer of backticks to represent a code block)
\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
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Required. A field name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may 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 may be quoted using (backtick). The only character that needs
to 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:
(Note: Comments here are written in markdown syntax, so there is an
additional layer of backticks to represent a code block)
\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
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getTtlConfig()
public abstract Field.TtlConfig getTtlConfig() The TTL configuration for this Field.
Setting or unsetting this will enable or disable the TTL for
documents that have this Field.
.google.firestore.admin.v1.Field.TtlConfig ttl_config = 3;
| Returns | |
|---|---|
| Type | Description |
Field.TtlConfig |
The ttlConfig. |
getTtlConfigOrBuilder()
public abstract Field.TtlConfigOrBuilder getTtlConfigOrBuilder() The TTL configuration for this Field.
Setting or unsetting this will enable or disable the TTL for
documents that have this Field.
.google.firestore.admin.v1.Field.TtlConfig ttl_config = 3;
| Returns | |
|---|---|
| Type | Description |
Field.TtlConfigOrBuilder |
|
hasIndexConfig()
public abstract boolean hasIndexConfig() 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.
.google.firestore.admin.v1.Field.IndexConfig index_config = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the indexConfig field is set. |
hasTtlConfig()
public abstract boolean hasTtlConfig() The TTL configuration for this Field.
Setting or unsetting this will enable or disable the TTL for
documents that have this Field.
.google.firestore.admin.v1.Field.TtlConfig ttl_config = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ttlConfig field is set. |