com.google.firestore.v1

Class GetDocumentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.GetDocumentRequest

All Implemented Interfaces:

GetDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GetDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements GetDocumentRequestOrBuilder

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

Protobuf type google.firestore.v1.GetDocumentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetDocumentRequest.Builder The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].
static class	GetDocumentRequest.ConsistencySelectorCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	MASK_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	READ_TIME_FIELD_NUMBER
static int	TRANSACTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
GetDocumentRequest.ConsistencySelectorCase	getConsistencySelectorCase()
static GetDocumentRequest	getDefaultInstance()
GetDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DocumentMask	getMask() The fields to return.
DocumentMaskOrBuilder	getMaskOrBuilder() The fields to return.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<GetDocumentRequest>	getParserForType()
com.google.protobuf.Timestamp	getReadTime() 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.
int	getSerializedSize()
com.google.protobuf.ByteString	getTransaction() Reads the document in a transaction.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMask() The fields to return.
boolean	hasReadTime() Reads the version of the document at the given time.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GetDocumentRequest.Builder	newBuilder()
static GetDocumentRequest.Builder	newBuilder(GetDocumentRequest prototype)
GetDocumentRequest.Builder	newBuilderForType()
protected GetDocumentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GetDocumentRequest	parseDelimitedFrom(InputStream input)
static GetDocumentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(byte[] data)
static GetDocumentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(ByteBuffer data)
static GetDocumentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(com.google.protobuf.ByteString data)
static GetDocumentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static GetDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(InputStream input)
static GetDocumentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GetDocumentRequest>	parser()
GetDocumentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

MASK_FIELD_NUMBER

public static final int MASK_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getConsistencySelectorCase

public GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()

Specified by:

getConsistencySelectorCase in interface GetDocumentRequestOrBuilder

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.

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.

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

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.

hasReadTime

public boolean hasReadTime()

 Reads the version of the document at the given time.
 This may not be older than 60 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 60 seconds.
 

.google.protobuf.Timestamp read_time = 5;

Specified by:

getReadTime in interface GetDocumentRequestOrBuilder

Returns:

The readTime.

getReadTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()

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

.google.protobuf.Timestamp read_time = 5;

Specified by:

getReadTimeOrBuilder in interface GetDocumentRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GetDocumentRequest parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static GetDocumentRequest parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static GetDocumentRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static GetDocumentRequest parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public GetDocumentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GetDocumentRequest.Builder newBuilder()

newBuilder

public static GetDocumentRequest.Builder newBuilder(GetDocumentRequest prototype)

toBuilder

public GetDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GetDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GetDocumentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<GetDocumentRequest> parser()

getParserForType

public com.google.protobuf.Parser<GetDocumentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GetDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder