public final class GetDocumentRequest extends GeneratedMessageV3 implements GetDocumentRequestOrBuilderThe request for Firestore.GetDocument.
Protobuf type google.firestore.v1.GetDocumentRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GetDocumentRequestImplements
GetDocumentRequestOrBuilderStatic Fields
MASK_FIELD_NUMBER
public static final int MASK_FIELD_NUMBER| Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
int |
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER| Type | Description |
int |
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static GetDocumentRequest getDefaultInstance()| Type | Description |
GetDocumentRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static GetDocumentRequest.Builder newBuilder()| Type | Description |
GetDocumentRequest.Builder |
newBuilder(GetDocumentRequest prototype)
public static GetDocumentRequest.Builder newBuilder(GetDocumentRequest prototype)| Name | Description |
prototype | GetDocumentRequest |
| Type | Description |
GetDocumentRequest.Builder |
parseDelimitedFrom(InputStream input)
public static GetDocumentRequest parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
GetDocumentRequest |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
GetDocumentRequest |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static GetDocumentRequest parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
GetDocumentRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
GetDocumentRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static GetDocumentRequest parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
GetDocumentRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
GetDocumentRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static GetDocumentRequest parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
GetDocumentRequest |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
GetDocumentRequest |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static GetDocumentRequest parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
GetDocumentRequest |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
GetDocumentRequest |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static GetDocumentRequest parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
GetDocumentRequest |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
GetDocumentRequest |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<GetDocumentRequest> parser()| Type | Description |
Parser<GetDocumentRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
getConsistencySelectorCase()
public GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()| Type | Description |
GetDocumentRequest.ConsistencySelectorCase |
getDefaultInstanceForType()
public GetDocumentRequest getDefaultInstanceForType()| Type | Description |
GetDocumentRequest |
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;
| Type | Description |
DocumentMask | 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;
| Type | Description |
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];
| 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];
| Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<GetDocumentRequest> getParserForType()| Type | Description |
Parser<GetDocumentRequest> |
getReadTime()
public 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;
| Type | Description |
Timestamp | The readTime. |
getReadTimeOrBuilder()
public 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;
| Type | Description |
TimestampOrBuilder |
getSerializedSize()
public int getSerializedSize()| Type | Description |
int |
getTransaction()
public ByteString getTransaction()Reads the document in a transaction.
bytes transaction = 3;
| Type | Description |
ByteString | The transaction. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
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;
| Type | Description |
boolean | Whether the mask field is set. |
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;
| Type | Description |
boolean | Whether the readTime field is set. |
hasTransaction()
public boolean hasTransaction()Reads the document in a transaction.
bytes transaction = 3;
| Type | Description |
boolean | Whether the transaction field is set. |
hashCode()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public GetDocumentRequest.Builder newBuilderForType()| Type | Description |
GetDocumentRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
GetDocumentRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public GetDocumentRequest.Builder toBuilder()| Type | Description |
GetDocumentRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |