public interface GetDocumentRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getConsistencySelectorCase()
public abstract GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.ConsistencySelectorCase |
|
getMask()
public abstract 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 | |
|---|---|
| Type | Description |
DocumentMask |
The mask. |
getMaskOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
DocumentMaskOrBuilder |
|
getName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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. |
getReadTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp |
The readTime. |
getReadTimeOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getTransaction()
public abstract ByteString getTransaction()Reads the document in a transaction.
bytes transaction = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The transaction. |
hasMask()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the mask field is set. |
hasReadTime()
public abstract 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 abstract boolean hasTransaction()Reads the document in a transaction.
bytes transaction = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transaction field is set. |