public final class Field extends GeneratedMessageV3 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
Static Fields
INDEX_CONFIG_FIELD_NUMBER
public static final int INDEX_CONFIG_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
TTL_CONFIG_FIELD_NUMBER
public static final int TTL_CONFIG_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Field getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Field.Builder newBuilder()
Returns
newBuilder(Field prototype)
public static Field.Builder newBuilder(Field prototype)
Parameter
| Name | Description |
| prototype | Field
|
Returns
public static Field parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Field parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Field parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Field parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Field parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Field parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Field parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Field parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Field parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Field parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Field parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Field parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Field> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Field getDefaultInstanceForType()
Returns
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;
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];
getParserForType()
public Parser<Field> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Field.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Field.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Field.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
