com.google.firestore.admin.v1

Interface ExportDocumentsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExportDocumentsRequest, ExportDocumentsRequest.Builder

public interface ExportDocumentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCollectionIds(int index) Which collection ids to export.
com.google.protobuf.ByteString	getCollectionIdsBytes(int index) Which collection ids to export.
int	getCollectionIdsCount() Which collection ids to export.
List<String>	getCollectionIdsList() Which collection ids to export.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getOutputUriPrefix() The output URI.
com.google.protobuf.ByteString	getOutputUriPrefixBytes() The output URI.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getCollectionIdsList

List<String> getCollectionIdsList()

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Returns:

A list containing the collectionIds.

getCollectionIdsCount

int getCollectionIdsCount()

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Returns:

The count of collectionIds.

getCollectionIds

String getCollectionIds(int index)

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Parameters:

index - The index of the element to return.

Returns:

The collectionIds at the given index.

getCollectionIdsBytes

com.google.protobuf.ByteString getCollectionIdsBytes(int index)

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the collectionIds at the given index.

getOutputUriPrefix

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:

The outputUriPrefix.

getOutputUriPrefixBytes

com.google.protobuf.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:

The bytes for outputUriPrefix.