Interface ExportDocumentsRequestOrBuilder (3.28.0)

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. Each collection ID in this list must be unique.

repeated string collection_ids = 2;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`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. Each collection ID in this list must be unique.

repeated string collection_ids = 2;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public abstract int getCollectionIdsCount()

Which collection IDs to export. Unspecified means all collections. Each collection ID in this list must be unique.

repeated string collection_ids = 2;

Returns
Type	Description
`int`	The count of collectionIds.

getCollectionIdsList()

public abstract List<String> getCollectionIdsList()

Which collection IDs to export. Unspecified means all collections. Each collection ID in this list must be unique.

repeated string collection_ids = 2;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`ByteString`	The bytes for name.

getNamespaceIds(int index)

public abstract String getNamespaceIds(int index)

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The namespaceIds at the given index.

getNamespaceIdsBytes(int index)

public abstract ByteString getNamespaceIdsBytes(int index)

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

repeated string namespace_ids = 4;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the namespaceIds at the given index.

getNamespaceIdsCount()

public abstract int getNamespaceIdsCount()

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

repeated string namespace_ids = 4;

Returns
Type	Description
`int`	The count of namespaceIds.

getNamespaceIdsList()

public abstract List<String> getNamespaceIdsList()

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

repeated string namespace_ids = 4;

Returns
Type	Description
`List<String>`	A list containing the namespaceIds.

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
Type	Description
`String`	The outputUriPrefix.

getOutputUriPrefixBytes()

public abstract ByteString getOutputUriPrefixBytes()

string output_uri_prefix = 3;

Returns
Type	Description
`ByteString`	The bytes for outputUriPrefix.

getSnapshotTime()

public abstract Timestamp getSnapshotTime()

The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than earliestVersionTime. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.

.google.protobuf.Timestamp snapshot_time = 5;

Returns
Type	Description
`Timestamp`	The snapshotTime.

getSnapshotTimeOrBuilder()

public abstract TimestampOrBuilder getSnapshotTimeOrBuilder()

.google.protobuf.Timestamp snapshot_time = 5;

Returns
Type	Description
`TimestampOrBuilder`

hasSnapshotTime()

public abstract boolean hasSnapshotTime()

.google.protobuf.Timestamp snapshot_time = 5;

Returns
Type	Description
`boolean`	Whether the snapshotTime field is set.