Class UpdateFieldRequest (3.21.4)

public final class UpdateFieldRequest extends GeneratedMessageV3 implements UpdateFieldRequestOrBuilder

The request for FirestoreAdmin.UpdateField.

Protobuf type google.firestore.admin.v1.UpdateFieldRequest

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateFieldRequest getDefaultInstance()
Returns
Type Description
UpdateFieldRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UpdateFieldRequest.Builder newBuilder()
Returns
Type Description
UpdateFieldRequest.Builder

newBuilder(UpdateFieldRequest prototype)

public static UpdateFieldRequest.Builder newBuilder(UpdateFieldRequest prototype)
Parameter
Name Description
prototype UpdateFieldRequest
Returns
Type Description
UpdateFieldRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateFieldRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateFieldRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateFieldRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateFieldRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateFieldRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateFieldRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateFieldRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateFieldRequest> parser()
Returns
Type Description
Parser<UpdateFieldRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UpdateFieldRequest getDefaultInstanceForType()
Returns
Type Description
UpdateFieldRequest

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.

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

getParserForType()

public Parser<UpdateFieldRequest> getParserForType()
Returns
Type Description
Parser<UpdateFieldRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateFieldRequest.Builder newBuilderForType()
Returns
Type Description
UpdateFieldRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateFieldRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateFieldRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateFieldRequest.Builder toBuilder()
Returns
Type Description
UpdateFieldRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException