Class UpdateFieldRequest.Builder

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateFieldRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

build()

public UpdateFieldRequest build()
Returns
TypeDescription
UpdateFieldRequest

buildPartial()

public UpdateFieldRequest buildPartial()
Returns
TypeDescription
UpdateFieldRequest

clear()

public UpdateFieldRequest.Builder clear()
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

clearField()

public UpdateFieldRequest.Builder clearField()

Required. The field to be updated.

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

Returns
TypeDescription
UpdateFieldRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateFieldRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateFieldRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

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
TypeDescription
UpdateFieldRequest.Builder

clone()

public UpdateFieldRequest.Builder clone()
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateFieldRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateFieldRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getField()

public Field getField()

Required. The field to be updated.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
FieldMaskOrBuilder

hasField()

public boolean hasField()

Required. The field to be updated.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueField
Returns
TypeDescription
UpdateFieldRequest.Builder

mergeFrom(UpdateFieldRequest other)

public UpdateFieldRequest.Builder mergeFrom(UpdateFieldRequest other)
Parameter
NameDescription
otherUpdateFieldRequest
Returns
TypeDescription
UpdateFieldRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateFieldRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateFieldRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateFieldRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

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
NameDescription
valueFieldMask
Returns
TypeDescription
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
NameDescription
valueField
Returns
TypeDescription
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
NameDescription
builderForValueField.Builder
Returns
TypeDescription
UpdateFieldRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateFieldRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

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

public UpdateFieldRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateFieldRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

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
NameDescription
valueFieldMask
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateFieldRequest.Builder