Class Field (3.21.0)

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

Implements

FieldOrBuilder

Static Fields

INDEX_CONFIG_FIELD_NUMBER

public static final int INDEX_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TTL_CONFIG_FIELD_NUMBER

public static final int TTL_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Field getDefaultInstance()
Returns
Type Description
Field

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Field.Builder newBuilder()
Returns
Type Description
Field.Builder

newBuilder(Field prototype)

public static Field.Builder newBuilder(Field prototype)
Parameter
Name Description
prototype Field
Returns
Type Description
Field.Builder

parseDelimitedFrom(InputStream input)

public static Field parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Field parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Field parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Field parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Field parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Field parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Field> parser()
Returns
Type Description
Parser<Field>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Field getDefaultInstanceForType()
Returns
Type Description
Field

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;

Returns
Type Description
Field.IndexConfig

The indexConfig.

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;

Returns
Type Description
Field.IndexConfigOrBuilder

getName()

public 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 index configuration.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
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 *, 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 index configuration.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Field> getParserForType()
Returns
Type Description
Parser<Field>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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;

Returns
Type Description
Field.TtlConfig

The ttlConfig.

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;

Returns
Type Description
Field.TtlConfigOrBuilder

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;

Returns
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;

Returns
Type Description
boolean

Whether the ttlConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Field.Builder newBuilderForType()
Returns
Type Description
Field.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Field.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Field.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Field.Builder toBuilder()
Returns
Type Description
Field.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException