Class UpdateFieldRequest (3.17.0)

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
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateFieldRequest getDefaultInstance()
Returns
TypeDescription
UpdateFieldRequest

getDescriptor()

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

newBuilder()

public static UpdateFieldRequest.Builder newBuilder()
Returns
TypeDescription
UpdateFieldRequest.Builder

newBuilder(UpdateFieldRequest prototype)

public static UpdateFieldRequest.Builder newBuilder(UpdateFieldRequest prototype)
Parameter
NameDescription
prototypeUpdateFieldRequest
Returns
TypeDescription
UpdateFieldRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateFieldRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateFieldRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateFieldRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateFieldRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateFieldRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateFieldRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateFieldRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateFieldRequest> parser()
Returns
TypeDescription
Parser<UpdateFieldRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UpdateFieldRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateFieldRequest

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.

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

getParserForType()

public Parser<UpdateFieldRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateFieldRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateFieldRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateFieldRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateFieldRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateFieldRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateFieldRequest.Builder toBuilder()
Returns
TypeDescription
UpdateFieldRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException