com.google.firestore.admin.v1

Class Field

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.admin.v1.Field

All Implemented Interfaces:

FieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Field
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Builder Represents a single field in the database.
static class	Field.IndexConfig The index configuration for this field.
static interface	Field.IndexConfigOrBuilder
static class	Field.TtlConfig The TTL (time-to-live) configuration for documents that have this `Field` set.
static interface	Field.TtlConfigOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_CONFIG_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TTL_CONFIG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Field	getDefaultInstance()
Field	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Field.IndexConfig	getIndexConfig() The index configuration for this field.
Field.IndexConfigOrBuilder	getIndexConfigOrBuilder() The index configuration for this field.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<Field>	getParserForType()
int	getSerializedSize()
Field.TtlConfig	getTtlConfig() The TTL configuration for this `Field`.
Field.TtlConfigOrBuilder	getTtlConfigOrBuilder() The TTL configuration for this `Field`.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasIndexConfig() The index configuration for this field.
boolean	hasTtlConfig() The TTL configuration for this `Field`.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Field.Builder	newBuilder()
static Field.Builder	newBuilder(Field prototype)
Field.Builder	newBuilderForType()
protected Field.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Field	parseDelimitedFrom(InputStream input)
static Field	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(byte[] data)
static Field	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(ByteBuffer data)
static Field	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(com.google.protobuf.ByteString data)
static Field	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(com.google.protobuf.CodedInputStream input)
static Field	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field	parseFrom(InputStream input)
static Field	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Field>	parser()
Field.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_CONFIG_FIELD_NUMBER

public static final int INDEX_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

TTL_CONFIG_FIELD_NUMBER

public static final int TTL_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

Specified by:

getName in interface FieldOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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];

Specified by:

getNameBytes in interface FieldOrBuilder

Returns:

The bytes for name.

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;

Specified by:

hasIndexConfig in interface FieldOrBuilder

Returns:

Whether the indexConfig field is set.

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;

Specified by:

getIndexConfig in interface FieldOrBuilder

Returns:

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;

Specified by:

getIndexConfigOrBuilder in interface FieldOrBuilder

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;

Specified by:

hasTtlConfig in interface FieldOrBuilder

Returns:

Whether the ttlConfig field is set.

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;

Specified by:

getTtlConfig in interface FieldOrBuilder

Returns:

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;

Specified by:

getTtlConfigOrBuilder in interface FieldOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Field parseFrom(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field parseDelimitedFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(com.google.protobuf.CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Field parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Field.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Field.Builder newBuilder()

newBuilder

public static Field.Builder newBuilder(Field prototype)

toBuilder

public Field.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Field.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Field getDefaultInstance()

parser

public static com.google.protobuf.Parser<Field> parser()

getParserForType

public com.google.protobuf.Parser<Field> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Field getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder