Class GetDocumentRequest.Builder (3.20.0)

public static final class GetDocumentRequest.Builder extends GeneratedMessageV3.Builder<GetDocumentRequest.Builder> implements GetDocumentRequestOrBuilder

The request for Firestore.GetDocument.

Protobuf type google.firestore.v1.GetDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public GetDocumentRequest build()
Returns
TypeDescription
GetDocumentRequest

buildPartial()

public GetDocumentRequest buildPartial()
Returns
TypeDescription
GetDocumentRequest

clear()

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

clearConsistencySelector()

public GetDocumentRequest.Builder clearConsistencySelector()
Returns
TypeDescription
GetDocumentRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMask()

public GetDocumentRequest.Builder clearMask()

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Returns
TypeDescription
GetDocumentRequest.Builder

clearName()

public GetDocumentRequest.Builder clearName()

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
GetDocumentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReadTime()

public GetDocumentRequest.Builder clearReadTime()

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Returns
TypeDescription
GetDocumentRequest.Builder

clearTransaction()

public GetDocumentRequest.Builder clearTransaction()

Reads the document in a transaction.

bytes transaction = 3;

Returns
TypeDescription
GetDocumentRequest.Builder

This builder for chaining.

clone()

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

getConsistencySelectorCase()

public GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()
Returns
TypeDescription
GetDocumentRequest.ConsistencySelectorCase

getDefaultInstanceForType()

public GetDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
GetDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMask()

public DocumentMask getMask()

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Returns
TypeDescription
DocumentMask

The mask.

getMaskBuilder()

public DocumentMask.Builder getMaskBuilder()

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Returns
TypeDescription
DocumentMask.Builder

getMaskOrBuilder()

public DocumentMaskOrBuilder getMaskOrBuilder()

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Returns
TypeDescription
DocumentMaskOrBuilder

getName()

public String getName()

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for name.

getReadTime()

public Timestamp getReadTime()

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Returns
TypeDescription
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getTransaction()

public ByteString getTransaction()

Reads the document in a transaction.

bytes transaction = 3;

Returns
TypeDescription
ByteString

The transaction.

hasMask()

public boolean hasMask()

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Returns
TypeDescription
boolean

Whether the mask field is set.

hasReadTime()

public boolean hasReadTime()

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Returns
TypeDescription
boolean

Whether the readTime field is set.

hasTransaction()

public boolean hasTransaction()

Reads the document in a transaction.

bytes transaction = 3;

Returns
TypeDescription
boolean

Whether the transaction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GetDocumentRequest other)

public GetDocumentRequest.Builder mergeFrom(GetDocumentRequest other)
Parameter
NameDescription
otherGetDocumentRequest
Returns
TypeDescription
GetDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMask(DocumentMask value)

public GetDocumentRequest.Builder mergeMask(DocumentMask value)

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Parameter
NameDescription
valueDocumentMask
Returns
TypeDescription
GetDocumentRequest.Builder

mergeReadTime(Timestamp value)

public GetDocumentRequest.Builder mergeReadTime(Timestamp value)

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
GetDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setMask(DocumentMask value)

public GetDocumentRequest.Builder setMask(DocumentMask value)

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Parameter
NameDescription
valueDocumentMask
Returns
TypeDescription
GetDocumentRequest.Builder

setMask(DocumentMask.Builder builderForValue)

public GetDocumentRequest.Builder setMask(DocumentMask.Builder builderForValue)

The fields to return. If not set, returns all fields.

If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 2;

Parameter
NameDescription
builderForValueDocumentMask.Builder
Returns
TypeDescription
GetDocumentRequest.Builder

setName(String value)

public GetDocumentRequest.Builder setName(String value)

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
GetDocumentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetDocumentRequest.Builder setNameBytes(ByteString value)

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
GetDocumentRequest.Builder

This builder for chaining.

setReadTime(Timestamp value)

public GetDocumentRequest.Builder setReadTime(Timestamp value)

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
GetDocumentRequest.Builder

setReadTime(Timestamp.Builder builderForValue)

public GetDocumentRequest.Builder setReadTime(Timestamp.Builder builderForValue)

Reads the version of the document at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

.google.protobuf.Timestamp read_time = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
GetDocumentRequest.Builder

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

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

setTransaction(ByteString value)

public GetDocumentRequest.Builder setTransaction(ByteString value)

Reads the document in a transaction.

bytes transaction = 3;

Parameter
NameDescription
valueByteString

The transaction to set.

Returns
TypeDescription
GetDocumentRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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