public static final class GetDocumentRequest.Builder extends GeneratedMessageV3.Builder<GetDocumentRequest.Builder> implements GetDocumentRequestOrBuilderThe request for Firestore.GetDocument.
Protobuf type google.firestore.v1.GetDocumentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GetDocumentRequest.BuilderImplements
GetDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
build()
public GetDocumentRequest build()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest | |
buildPartial()
public GetDocumentRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest | |
clear()
public GetDocumentRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
clearConsistencySelector()
public GetDocumentRequest.Builder clearConsistencySelector()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public GetDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
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 | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GetDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
clearReadTime()
public GetDocumentRequest.Builder clearReadTime()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 |
GetDocumentRequest.Builder | |
clearTransaction()
public GetDocumentRequest.Builder clearTransaction()Reads the document in a transaction.
bytes transaction = 3;
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | This builder for chaining. |
clone()
public GetDocumentRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
getConsistencySelectorCase()
public GetDocumentRequest.ConsistencySelectorCase getConsistencySelectorCase()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.ConsistencySelectorCase | |
getDefaultInstanceForType()
public GetDocumentRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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;
| Returns | |
|---|---|
| Type | Description |
DocumentMask | The mask. |
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;
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
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;
| Returns | |
|---|---|
| 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];
| 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. |
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;
| Returns | |
|---|---|
| Type | Description |
Timestamp | The readTime. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()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 |
Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getTransaction()
public ByteString getTransaction()Reads the document in a transaction.
bytes transaction = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The transaction. |
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;
| 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(GetDocumentRequest other)
public GetDocumentRequest.Builder mergeFrom(GetDocumentRequest other)| Parameter | |
|---|---|
| Name | Description |
other | GetDocumentRequest |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GetDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public GetDocumentRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
mergeMask(DocumentMask value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | DocumentMask |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
mergeReadTime(Timestamp value)
public GetDocumentRequest.Builder mergeReadTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public GetDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setMask(DocumentMask value)
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;
| Parameter | |
|---|---|
| Name | Description |
value | DocumentMask |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setMask(DocumentMask.Builder builderForValue)
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DocumentMask.Builder |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setName(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public GetDocumentRequest.Builder setNameBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | This builder for chaining. |
setReadTime(Timestamp value)
public GetDocumentRequest.Builder setReadTime(Timestamp value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setReadTime(Timestamp.Builder builderForValue)
public GetDocumentRequest.Builder setReadTime(Timestamp.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GetDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |
setTransaction(ByteString value)
public GetDocumentRequest.Builder setTransaction(ByteString value)Reads the document in a transaction.
bytes transaction = 3;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe transaction to set. |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final GetDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder | |