Class ExportDocumentsRequest.Builder (3.21.4)

Version 3.21.4

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportDocumentsRequest.Builder

Implements

ExportDocumentsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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.

addAllNamespaceIds(Iterable<String> values)

public ExportDocumentsRequest.Builder addAllNamespaceIds(Iterable<String> values)

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
values	Iterable<String> The namespaceIds 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	String The 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	ByteString The bytes of the collectionIds to add.

Returns
Type	Description
ExportDocumentsRequest.Builder	This builder for chaining.

addNamespaceIds(String value)

public ExportDocumentsRequest.Builder addNamespaceIds(String value)

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
value	String The namespaceIds to add.

Returns
Type	Description
ExportDocumentsRequest.Builder	This builder for chaining.

addNamespaceIdsBytes(ByteString value)

public ExportDocumentsRequest.Builder addNamespaceIdsBytes(ByteString value)

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
value	ByteString The bytes of the namespaceIds 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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.

clearNamespaceIds()

public ExportDocumentsRequest.Builder clearNamespaceIds()

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;

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.

clearSnapshotTime()

public ExportDocumentsRequest.Builder clearSnapshotTime()

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

clone()

public ExportDocumentsRequest.Builder clone()

Returns
Type	Description
ExportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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	int The 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	int The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getNamespaceIds(int index)

public 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 ByteString getNamespaceIdsBytes(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 value to return.

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

getNamespaceIdsCount()

public int getNamespaceIdsCount()

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;

Returns
Type	Description
int	The count of namespaceIds.

getNamespaceIdsList()

public ProtocolStringList getNamespaceIdsList()

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;

Returns
Type	Description
ProtocolStringList	A list containing the namespaceIds.

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.

getSnapshotTime()

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

getSnapshotTimeBuilder()

public Timestamp.Builder getSnapshotTimeBuilder()

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
Builder

getSnapshotTimeOrBuilder()

public TimestampOrBuilder getSnapshotTimeOrBuilder()

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
TimestampOrBuilder

hasSnapshotTime()

public boolean hasSnapshotTime()

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
boolean	Whether the snapshotTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ExportDocumentsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ExportDocumentsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSnapshotTime(Timestamp value)

public ExportDocumentsRequest.Builder mergeSnapshotTime(Timestamp value)

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;

Parameter
Name	Description
value	Timestamp

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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	int The index to set the value at.
value	String The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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	String The 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	ByteString The bytes for name to set.

Returns
Type	Description
ExportDocumentsRequest.Builder	This builder for chaining.

setNamespaceIds(int index, String value)

public ExportDocumentsRequest.Builder setNamespaceIds(int index, String value)

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;

Parameters
Name	Description
index	int The index to set the value at.
value	String The namespaceIds 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	String The 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	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSnapshotTime(Timestamp value)

public ExportDocumentsRequest.Builder setSnapshotTime(Timestamp value)

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;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
ExportDocumentsRequest.Builder

setSnapshotTime(Timestamp.Builder builderForValue)

public ExportDocumentsRequest.Builder setSnapshotTime(Timestamp.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Builder

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)