Interface ExportDocumentsRequestOrBuilder (3.8.2)

public interface ExportDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollectionIds(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> getCollectionIdsList()

Which collection ids to export. Unspecified means all collections.

repeated string collection_ids = 2;

Returns
TypeDescription
List<String>

A list containing the collectionIds.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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.