public static final class ExportDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder> implements ExportDocumentsRequestOrBuilderThe request for FirestoreAdmin.ExportDocuments.
Protobuf type google.firestore.admin.v1.ExportDocumentsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportDocumentsRequest.BuilderImplements
ExportDocumentsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCollectionIds(Iterable<String> values)
public ExportDocumentsRequest.Builder addAllCollectionIds(Iterable<String> values)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The collectionIds to add. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
addCollectionIds(String value)
public ExportDocumentsRequest.Builder addCollectionIds(String value)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe collectionIds to add. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
addCollectionIdsBytes(ByteString value)
public ExportDocumentsRequest.Builder addCollectionIdsBytes(ByteString value)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the collectionIds to add. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
build()
public ExportDocumentsRequest build()| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest |
|
buildPartial()
public ExportDocumentsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest |
|
clear()
public ExportDocumentsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
clearCollectionIds()
public ExportDocumentsRequest.Builder clearCollectionIds()Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ExportDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
clearName()
public ExportDocumentsRequest.Builder clearName() Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
clearOutputUriPrefix()
public ExportDocumentsRequest.Builder clearOutputUriPrefix() The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
clone()
public ExportDocumentsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
getCollectionIds(int index)
public String getCollectionIds(int index)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The collectionIds at the given index. |
getCollectionIdsBytes(int index)
public ByteString getCollectionIdsBytes(int index)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the collectionIds at the given index. |
getCollectionIdsCount()
public int getCollectionIdsCount()Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The count of collectionIds. |
getCollectionIdsList()
public ProtocolStringList getCollectionIdsList()Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the collectionIds. |
getDefaultInstanceForType()
public ExportDocumentsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getName()
public String getName() Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOutputUriPrefix()
public String getOutputUriPrefix() The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The outputUriPrefix. |
getOutputUriPrefixBytes()
public ByteString getOutputUriPrefixBytes() The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for outputUriPrefix. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ExportDocumentsRequest other)
public ExportDocumentsRequest.Builder mergeFrom(ExportDocumentsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExportDocumentsRequest |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExportDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExportDocumentsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
setCollectionIds(int index, String value)
public ExportDocumentsRequest.Builder setCollectionIds(int index, String value)Which collection ids to export. Unspecified means all collections.
repeated string collection_ids = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe collectionIds to set. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ExportDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
setName(String value)
public ExportDocumentsRequest.Builder setName(String value) Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public ExportDocumentsRequest.Builder setNameBytes(ByteString value) Required. Database to export. Should be of the form:
projects/{project_id}/databases/{database_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
setOutputUriPrefix(String value)
public ExportDocumentsRequest.Builder setOutputUriPrefix(String value) The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe outputUriPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
setOutputUriPrefixBytes(ByteString value)
public ExportDocumentsRequest.Builder setOutputUriPrefixBytes(ByteString value) The output URI. Currently only supports Google Cloud Storage URIs of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name
of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional
Google Cloud Storage namespace path. When
choosing a name, be sure to consider Google Cloud Storage naming
guidelines: https://cloud.google.com/storage/docs/naming.
If the URI is a bucket (without a namespace path), a prefix will be
generated based on the start time.
string output_uri_prefix = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for outputUriPrefix to set. |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportDocumentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportDocumentsRequest.Builder |
|