Class UpdateFieldRequest.Builder (3.1.0)

Version 3.1.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class UpdateFieldRequest.Builder extends GeneratedMessageV3.Builder<UpdateFieldRequest.Builder> implements UpdateFieldRequestOrBuilder

The request for FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.UpdateFieldRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateFieldRequest.Builder

Implements

UpdateFieldRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateFieldRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public UpdateFieldRequest build()

Returns

Type	Description
UpdateFieldRequest

buildPartial()

public UpdateFieldRequest buildPartial()

Returns

Type	Description
UpdateFieldRequest

clear()

public UpdateFieldRequest.Builder clear()

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField()

public UpdateFieldRequest.Builder clearField()

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
UpdateFieldRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateFieldRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateFieldRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearUpdateMask()

public UpdateFieldRequest.Builder clearUpdateMask()

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Returns

Type	Description
UpdateFieldRequest.Builder

clone()

public UpdateFieldRequest.Builder clone()

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public UpdateFieldRequest getDefaultInstanceForType()

Returns

Type	Description
UpdateFieldRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getField()

public Field getField()

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Field	The field.

getFieldBuilder()

public Field.Builder getFieldBuilder()

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Field.Builder

getFieldOrBuilder()

public FieldOrBuilder getFieldOrBuilder()

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
FieldOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Returns

Type	Description
FieldMask	The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Returns

Type	Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Returns

Type	Description
FieldMaskOrBuilder

hasField()

public boolean hasField()

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the field field is set.

hasUpdateMask()

public boolean hasUpdateMask()

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Returns

Type	Description
boolean	Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeField(Field value)

public UpdateFieldRequest.Builder mergeField(Field value)

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Field

Returns

Type	Description
UpdateFieldRequest.Builder

mergeFrom(UpdateFieldRequest other)

public UpdateFieldRequest.Builder mergeFrom(UpdateFieldRequest other)

Parameter

Name	Description
other	UpdateFieldRequest

Returns

Type	Description
UpdateFieldRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateFieldRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public UpdateFieldRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateFieldRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateMask(FieldMask value)

public UpdateFieldRequest.Builder mergeUpdateMask(FieldMask value)

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Parameter

Name	Description
value	FieldMask

Returns

Type	Description
UpdateFieldRequest.Builder

setField(Field value)

public UpdateFieldRequest.Builder setField(Field value)

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Field

Returns

Type	Description
UpdateFieldRequest.Builder

setField(Field.Builder builderForValue)

public UpdateFieldRequest.Builder setField(Field.Builder builderForValue)

Required. The field to be updated.

.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	Field.Builder

Returns

Type	Description
UpdateFieldRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateFieldRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateFieldRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateFieldRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
UpdateFieldRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateMask(FieldMask value)

public UpdateFieldRequest.Builder setUpdateMask(FieldMask value)

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Parameter

Name	Description
value	FieldMask

Returns

Type	Description
UpdateFieldRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateFieldRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

.google.protobuf.FieldMask update_mask = 2;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
UpdateFieldRequest.Builder