Send feedback
Class GetDocumentRequest (3.14.2)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.14.2 keyboard_arrow_down
public final class GetDocumentRequest extends GeneratedMessageV3 implements GetDocumentRequestOrBuilder
The request for
Firestore.GetDocument .
Protobuf type google.firestore.v1.GetDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
MASK_FIELD_NUMBER
public static final int MASK_FIELD_NUMBER
Field Value Type Description int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value Type Description int
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value Type Description int
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static GetDocumentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static GetDocumentRequest . Builder newBuilder ()
newBuilder(GetDocumentRequest prototype)
public static GetDocumentRequest . Builder newBuilder ( GetDocumentRequest prototype )
public static GetDocumentRequest parseDelimitedFrom ( InputStream input )
public static GetDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static GetDocumentRequest parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static GetDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static GetDocumentRequest parseFrom ( CodedInputStream input )
public static GetDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static GetDocumentRequest parseFrom ( InputStream input )
public static GetDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static GetDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<GetDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
getConsistencySelectorCase()
public GetDocumentRequest . ConsistencySelectorCase getConsistencySelectorCase ()
getDefaultInstanceForType()
public GetDocumentRequest getDefaultInstanceForType ()
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;
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;
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 Type Description 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 Type Description ByteString The bytes for name.
getParserForType()
public Parser<GetDocumentRequest> getParserForType ()
Overrides
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;
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;
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getTransaction()
public ByteString getTransaction ()
Reads the document in a transaction.
bytes transaction = 3;
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 Type Description 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 Type Description boolean Whether the readTime field is set.
hasTransaction()
public boolean hasTransaction ()
Reads the document in a transaction.
bytes transaction = 3;
Returns Type Description boolean Whether the transaction field is set.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public GetDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public GetDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
