Class ExportDocumentsRequest.Builder (3.9.5)

public static final class ExportDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder> implements ExportDocumentsRequestOrBuilder

The request for FirestoreAdmin.ExportDocuments.

Protobuf type google.firestore.admin.v1.ExportDocumentsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The collectionIds to add.

Returns
TypeDescription
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
NameDescription
valueString

The collectionIds to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the collectionIds to add.

Returns
TypeDescription
ExportDocumentsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

build()

public ExportDocumentsRequest build()
Returns
TypeDescription
ExportDocumentsRequest

buildPartial()

public ExportDocumentsRequest buildPartial()
Returns
TypeDescription
ExportDocumentsRequest

clear()

public ExportDocumentsRequest.Builder clear()
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

clearCollectionIds()

public ExportDocumentsRequest.Builder clearCollectionIds()

Which collection ids to export. Unspecified means all collections.

repeated string collection_ids = 2;

Returns
TypeDescription
ExportDocumentsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExportDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

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
TypeDescription
ExportDocumentsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

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
TypeDescription
ExportDocumentsRequest.Builder

This builder for chaining.

clone()

public ExportDocumentsRequest.Builder clone()
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

getCollectionIds(int index)

public String getCollectionIds(int index)

Which collection ids to export. Unspecified means all collections.

repeated string collection_ids = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Which collection ids to export. Unspecified means all collections.

repeated string collection_ids = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public ExportDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ExportDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for outputUriPrefix.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExportDocumentsRequest other)

public ExportDocumentsRequest.Builder mergeFrom(ExportDocumentsRequest other)
Parameter
NameDescription
otherExportDocumentsRequest
Returns
TypeDescription
ExportDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExportDocumentsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

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
NameDescription
indexint

The index to set the value at.

valueString

The collectionIds to set.

Returns
TypeDescription
ExportDocumentsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExportDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueString

The outputUriPrefix to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for outputUriPrefix to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportDocumentsRequest.Builder
Overrides