public static final class UpdateFieldRequest.Builder extends GeneratedMessage.Builder<UpdateFieldRequest.Builder> implements UpdateFieldRequestOrBuilderThe request for FirestoreAdmin.UpdateField.
Protobuf type google.firestore.admin.v1.UpdateFieldRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > UpdateFieldRequest.BuilderImplements
UpdateFieldRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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 |
|
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 |
|
getDefaultInstanceForType()
public UpdateFieldRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UpdateFieldRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UpdateFieldRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UpdateFieldRequest.Builder |
|
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 |
|
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 |
|