Field.Builder (proto-google-cloud-firestore-admin-v1 1.35.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>
    - - com.google.firestore.admin.v1.Field.Builder

All Implemented Interfaces:: FieldOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Field

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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.
`Field.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`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()` 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.
`com.google.protobuf.ByteString`	`getNameBytes()` 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.
`boolean`	`hasIndexConfig()` The index 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`	`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)` 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.
`Field.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` 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.
`Field.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Field.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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.Builder<Field.Builder>

clear
```
public Field.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

getDefaultInstanceForType
```
public Field getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Field build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Field buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Field.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

setField

public Field.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                              Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

clearField
```
public Field.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

clearOneof
```
public Field.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

setRepeatedField

public Field.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

addRepeatedField

public Field.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

mergeFrom
```
public Field.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.Builder>

mergeFrom

public Field.Builder mergeFrom(Field other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Field.Builder>

mergeFrom
```
public Field.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.Builder>

Throws:

IOException

getName

public String getName()

 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;

Specified by:: getName in interface FieldOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 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;

Specified by:: getNameBytes in interface FieldOrBuilder
Returns:: The bytes for name.

setName

public Field.Builder setName(String value)

 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;

Parameters:: value - The name to set.
Returns:: This builder for chaining.

clearName

public Field.Builder clearName()

 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;

Returns:: This builder for chaining.

setNameBytes

public Field.Builder setNameBytes(com.google.protobuf.ByteString value)

 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;

Parameters:: value - The bytes for name to set.
Returns:: This builder for chaining.