public static final class Field.Builder extends GeneratedMessageV3.Builder<Field.Builder> implements FieldOrBuilder
Represents a single field in the database.
Fields are grouped by their "Collection Group", which represent all
collections in the database with the same id.
Protobuf type google.firestore.admin.v1.Field
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Field.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Field buildPartial()
Returns
clear()
public Field.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public Field.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearIndexConfig()
public Field.Builder clearIndexConfig()
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;
clearName()
public Field.Builder clearName()
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 (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];
clearOneof(Descriptors.OneofDescriptor oneof)
public Field.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearTtlConfig()
public Field.Builder clearTtlConfig()
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;
clone()
public Field.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Field getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getIndexConfig()
public 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;
getIndexConfigBuilder()
public Field.IndexConfig.Builder getIndexConfigBuilder()
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;
getIndexConfigOrBuilder()
public 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;
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 (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];
| Type | Description |
| String | The name.
|
getNameBytes()
public 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 (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];
getTtlConfig()
public 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;
getTtlConfigBuilder()
public Field.TtlConfig.Builder getTtlConfigBuilder()
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;
getTtlConfigOrBuilder()
public 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;
hasIndexConfig()
public 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;
| Type | Description |
| boolean | Whether the indexConfig field is set.
|
hasTtlConfig()
public 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;
| Type | Description |
| boolean | Whether the ttlConfig field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Field other)
public Field.Builder mergeFrom(Field other)
Parameter
| Name | Description |
| other | Field
|
Returns
public Field.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Field.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeIndexConfig(Field.IndexConfig value)
public Field.Builder mergeIndexConfig(Field.IndexConfig value)
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;
mergeTtlConfig(Field.TtlConfig value)
public Field.Builder mergeTtlConfig(Field.TtlConfig value)
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Field.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public Field.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setIndexConfig(Field.IndexConfig value)
public Field.Builder setIndexConfig(Field.IndexConfig value)
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;
setIndexConfig(Field.IndexConfig.Builder builderForValue)
public Field.Builder setIndexConfig(Field.IndexConfig.Builder builderForValue)
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;
setName(String value)
public Field.Builder setName(String value)
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 (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];
| Name | Description |
| value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public Field.Builder setNameBytes(ByteString value)
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 (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];
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Field.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setTtlConfig(Field.TtlConfig value)
public Field.Builder setTtlConfig(Field.TtlConfig value)
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;
setTtlConfig(Field.TtlConfig.Builder builderForValue)
public Field.Builder setTtlConfig(Field.TtlConfig.Builder builderForValue)
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;
setUnknownFields(UnknownFieldSet unknownFields)
public final Field.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
