public static final class Field.Builder extends com.google.protobuf.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| Modifier and Type | Method and Description |
|---|---|
Field.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Field |
build() |
Field |
buildPartial() |
Field.Builder |
clear() |
Field.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Field.Builder |
clearIndexConfig()
The index configuration for this field.
|
Field.Builder |
clearName()
Required.
|
Field.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Field.Builder |
clearTtlConfig()
The TTL configuration for this `Field`.
|
Field.Builder |
clone() |
Field |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Field.IndexConfig |
getIndexConfig()
The index configuration for this field.
|
Field.IndexConfig.Builder |
getIndexConfigBuilder()
The index configuration for this field.
|
Field.IndexConfigOrBuilder |
getIndexConfigOrBuilder()
The index configuration for this field.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
Field.TtlConfig |
getTtlConfig()
The TTL configuration for this `Field`.
|
Field.TtlConfig.Builder |
getTtlConfigBuilder()
The TTL configuration for this `Field`.
|
Field.TtlConfigOrBuilder |
getTtlConfigOrBuilder()
The TTL configuration for this `Field`.
|
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() |
Field.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Field.Builder |
mergeFrom(Field other) |
Field.Builder |
mergeFrom(com.google.protobuf.Message other) |
Field.Builder |
mergeIndexConfig(Field.IndexConfig value)
The index configuration for this field.
|
Field.Builder |
mergeTtlConfig(Field.TtlConfig value)
The TTL configuration for this `Field`.
|
Field.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Field.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Field.Builder |
setIndexConfig(Field.IndexConfig.Builder builderForValue)
The index configuration for this field.
|
Field.Builder |
setIndexConfig(Field.IndexConfig value)
The index configuration for this field.
|
Field.Builder |
setName(String value)
Required.
|
Field.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Required.
|
Field.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Field.Builder |
setTtlConfig(Field.TtlConfig.Builder builderForValue)
The TTL configuration for this `Field`.
|
Field.Builder |
setTtlConfig(Field.TtlConfig value)
The TTL configuration for this `Field`.
|
Field.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Field build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Field buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Field.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.Builder>public Field.Builder mergeFrom(Field other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public Field.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.Builder>IOExceptionpublic 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];getName in interface FieldOrBuilderpublic 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];getNameBytes in interface FieldOrBuilderpublic 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 `*`, 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];value - The name to set.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 `*`, 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];public Field.Builder setNameBytes(com.google.protobuf.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 `*`, 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];value - The bytes for name to set.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;hasIndexConfig in interface FieldOrBuilderpublic 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;getIndexConfig in interface FieldOrBuilderpublic 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;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;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;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;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;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;getIndexConfigOrBuilder in interface FieldOrBuilderpublic 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;hasTtlConfig in interface FieldOrBuilderpublic 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;getTtlConfig in interface FieldOrBuilderpublic 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;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;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;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;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;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;getTtlConfigOrBuilder in interface FieldOrBuilderpublic final Field.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>public final Field.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>Copyright © 2023 Google LLC. All rights reserved.