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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateFieldRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public UpdateFieldRequest build()
buildPartial()
public UpdateFieldRequest buildPartial()
clear()
public UpdateFieldRequest.Builder clear()
Overrides
clearField()
public UpdateFieldRequest.Builder clearField()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
clearField(Descriptors.FieldDescriptor field)
public UpdateFieldRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateFieldRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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;
clone()
public UpdateFieldRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public UpdateFieldRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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];
getFieldOrBuilder()
public FieldOrBuilder getFieldOrBuilder()
Required. The field to be updated.
.google.firestore.admin.v1.Field field = 1 [(.google.api.field_behavior) = REQUIRED];
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;
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;
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()
Overrides
isInitialized()
public final boolean isInitialized()
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 |
| Name |
Description |
value |
Field
|
mergeFrom(UpdateFieldRequest other)
public UpdateFieldRequest.Builder mergeFrom(UpdateFieldRequest other)
public UpdateFieldRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public UpdateFieldRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateFieldRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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;
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
|
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];
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateFieldRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UpdateFieldRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateFieldRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
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;
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
|
