com.google.firestore.v1

Class GetDocumentRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

com.google.firestore.v1.GetDocumentRequest.Builder

All Implemented Interfaces:

GetDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GetDocumentRequest

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

 The request for
 [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].
 

Protobuf type google.firestore.v1.GetDocumentRequest

Method Summary

Modifier and Type	Method and Description
GetDocumentRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GetDocumentRequest	build()
GetDocumentRequest	buildPartial()
GetDocumentRequest.Builder	clear()
GetDocumentRequest.Builder	clearConsistencySelector()
GetDocumentRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
GetDocumentRequest.Builder	clearMask() The fields to return.
GetDocumentRequest.Builder	clearName() Required.
GetDocumentRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
GetDocumentRequest.Builder	clearReadTime() Reads the version of the document at the given time.
GetDocumentRequest.Builder	clearTransaction() Reads the document in a transaction.
GetDocumentRequest.Builder	clone()
GetDocumentRequest.ConsistencySelectorCase	getConsistencySelectorCase()
GetDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
DocumentMask	getMask() The fields to return.
DocumentMask.Builder	getMaskBuilder() The fields to return.
DocumentMaskOrBuilder	getMaskOrBuilder() The fields to return.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Timestamp	getReadTime() Reads the version of the document at the given time.
com.google.protobuf.Timestamp.Builder	getReadTimeBuilder() Reads the version of the document at the given time.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Reads the version of the document at the given time.
com.google.protobuf.ByteString	getTransaction() Reads the document in a transaction.
boolean	hasMask() The fields to return.
boolean	hasReadTime() Reads the version of the document at the given time.
boolean	hasTransaction() Reads the document in a transaction.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GetDocumentRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GetDocumentRequest.Builder	mergeFrom(GetDocumentRequest other)
GetDocumentRequest.Builder	mergeFrom(com.google.protobuf.Message other)
GetDocumentRequest.Builder	mergeMask(DocumentMask value) The fields to return.
GetDocumentRequest.Builder	mergeReadTime(com.google.protobuf.Timestamp value) Reads the version of the document at the given time.
GetDocumentRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GetDocumentRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GetDocumentRequest.Builder	setMask(DocumentMask.Builder builderForValue) The fields to return.
GetDocumentRequest.Builder	setMask(DocumentMask value) The fields to return.
GetDocumentRequest.Builder	setName(String value) Required.
GetDocumentRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.
GetDocumentRequest.Builder	setReadTime(com.google.protobuf.Timestamp.Builder builderForValue) Reads the version of the document at the given time.
GetDocumentRequest.Builder	setReadTime(com.google.protobuf.Timestamp value) Reads the version of the document at the given time.
GetDocumentRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
GetDocumentRequest.Builder	setTransaction(com.google.protobuf.ByteString value) Reads the document in a transaction.
GetDocumentRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

clear

public GetDocumentRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

getDefaultInstanceForType

public GetDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GetDocumentRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GetDocumentRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public GetDocumentRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

setField

public GetDocumentRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

clearField

public GetDocumentRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

clearOneof

public GetDocumentRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

setRepeatedField

public GetDocumentRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

addRepeatedField

public GetDocumentRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

mergeFrom

public GetDocumentRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetDocumentRequest.Builder>

mergeFrom

public GetDocumentRequest.Builder mergeFrom(GetDocumentRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

mergeFrom

public GetDocumentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetDocumentRequest.Builder>

Throws:

IOException

getConsistencySelectorCase

public GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()

Specified by:

getConsistencySelectorCase in interface GetDocumentRequestOrBuilder

clearConsistencySelector

public GetDocumentRequest.Builder clearConsistencySelector()

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];

Specified by:

getName in interface GetDocumentRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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];

Specified by:

getNameBytes in interface GetDocumentRequestOrBuilder

Returns:

The bytes for name.

setName

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];

Parameters:

value - The name to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setNameBytes

public GetDocumentRequest.Builder setNameBytes(com.google.protobuf.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];

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

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;

Specified by:

hasMask in interface GetDocumentRequestOrBuilder

Returns:

Whether the mask field is set.

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;

Specified by:

getMask in interface GetDocumentRequestOrBuilder

Returns:

The mask.

setMask

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;

setMask

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;

mergeMask

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;

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;

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;

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;

Specified by:

getMaskOrBuilder in interface GetDocumentRequestOrBuilder

hasTransaction

public boolean hasTransaction()

 Reads the document in a transaction.
 

bytes transaction = 3;

Specified by:

hasTransaction in interface GetDocumentRequestOrBuilder

Returns:

Whether the transaction field is set.

getTransaction

public com.google.protobuf.ByteString getTransaction()

 Reads the document in a transaction.
 

bytes transaction = 3;

Specified by:

getTransaction in interface GetDocumentRequestOrBuilder

Returns:

The transaction.

setTransaction

public GetDocumentRequest.Builder setTransaction(com.google.protobuf.ByteString value)

 Reads the document in a transaction.
 

bytes transaction = 3;

Parameters:

value - The transaction to set.

Returns:

This builder for chaining.

clearTransaction

public GetDocumentRequest.Builder clearTransaction()

 Reads the document in a transaction.
 

bytes transaction = 3;

Returns:

This builder for chaining.

hasReadTime

public boolean hasReadTime()

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

Specified by:

hasReadTime in interface GetDocumentRequestOrBuilder

Returns:

Whether the readTime field is set.

getReadTime

public com.google.protobuf.Timestamp getReadTime()

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

Specified by:

getReadTime in interface GetDocumentRequestOrBuilder

Returns:

The readTime.

setReadTime

public GetDocumentRequest.Builder setReadTime(com.google.protobuf.Timestamp value)

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

setReadTime

public GetDocumentRequest.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

mergeReadTime

public GetDocumentRequest.Builder mergeReadTime(com.google.protobuf.Timestamp value)

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

clearReadTime

public GetDocumentRequest.Builder clearReadTime()

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

getReadTimeBuilder

public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

getReadTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()

 Reads the version of the document at the given time.
 This may not be older than 270 seconds.
 

.google.protobuf.Timestamp read_time = 5;

Specified by:

getReadTimeOrBuilder in interface GetDocumentRequestOrBuilder

setUnknownFields

public final GetDocumentRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>

mergeUnknownFields

public final GetDocumentRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GetDocumentRequest.Builder>