com.google.firestore.admin.v1

Class ExportDocumentsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

com.google.firestore.admin.v1.ExportDocumentsRequest.Builder

All Implemented Interfaces:

ExportDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ExportDocumentsRequest

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

 The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
 

Protobuf type google.firestore.admin.v1.ExportDocumentsRequest

Method Summary

Modifier and Type	Method and Description
ExportDocumentsRequest.Builder	addAllCollectionIds(Iterable<String> values) Which collection ids to export.
ExportDocumentsRequest.Builder	addCollectionIds(String value) Which collection ids to export.
ExportDocumentsRequest.Builder	addCollectionIdsBytes(com.google.protobuf.ByteString value) Which collection ids to export.
ExportDocumentsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExportDocumentsRequest	build()
ExportDocumentsRequest	buildPartial()
ExportDocumentsRequest.Builder	clear()
ExportDocumentsRequest.Builder	clearCollectionIds() Which collection ids to export.
ExportDocumentsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ExportDocumentsRequest.Builder	clearName() Required.
ExportDocumentsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ExportDocumentsRequest.Builder	clearOutputUriPrefix() The output URI.
ExportDocumentsRequest.Builder	clone()
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.
com.google.protobuf.ProtocolStringList	getCollectionIdsList() Which collection ids to export.
ExportDocumentsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getOutputUriPrefix() The output URI.
com.google.protobuf.ByteString	getOutputUriPrefixBytes() The output URI.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ExportDocumentsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ExportDocumentsRequest.Builder	mergeFrom(ExportDocumentsRequest other)
ExportDocumentsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ExportDocumentsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExportDocumentsRequest.Builder	setCollectionIds(int index, String value) Which collection ids to export.
ExportDocumentsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExportDocumentsRequest.Builder	setName(String value) Required.
ExportDocumentsRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.
ExportDocumentsRequest.Builder	setOutputUriPrefix(String value) The output URI.
ExportDocumentsRequest.Builder	setOutputUriPrefixBytes(com.google.protobuf.ByteString value) The output URI.
ExportDocumentsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ExportDocumentsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

clear

public ExportDocumentsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

getDefaultInstanceForType

public ExportDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ExportDocumentsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ExportDocumentsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ExportDocumentsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

setField

public ExportDocumentsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

clearField

public ExportDocumentsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

clearOneof

public ExportDocumentsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

setRepeatedField

public ExportDocumentsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

addRepeatedField

public ExportDocumentsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

mergeFrom

public ExportDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportDocumentsRequest.Builder>

mergeFrom

public ExportDocumentsRequest.Builder mergeFrom(ExportDocumentsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

mergeFrom

public ExportDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExportDocumentsRequest.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getName in interface ExportDocumentsRequestOrBuilder

Returns:

The name.

getNameBytes

public 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) = { ... }

Specified by:

getNameBytes in interface ExportDocumentsRequestOrBuilder

Returns:

The bytes for name.

setName

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) = { ... }

Parameters:

value - The name to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setNameBytes

public ExportDocumentsRequest.Builder setNameBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getCollectionIdsList

public com.google.protobuf.ProtocolStringList getCollectionIdsList()

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Specified by:

getCollectionIdsList in interface ExportDocumentsRequestOrBuilder

Returns:

A list containing the collectionIds.

getCollectionIdsCount

public int getCollectionIdsCount()

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Specified by:

getCollectionIdsCount in interface ExportDocumentsRequestOrBuilder

Returns:

The count of collectionIds.

getCollectionIds

public String getCollectionIds(int index)

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Specified by:

getCollectionIds in interface ExportDocumentsRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The collectionIds at the given index.

getCollectionIdsBytes

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

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Specified by:

getCollectionIdsBytes in interface ExportDocumentsRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the collectionIds at the given index.

setCollectionIds

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

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Parameters:

index - The index to set the value at.

value - The collectionIds to set.

Returns:

This builder for chaining.

addCollectionIds

public ExportDocumentsRequest.Builder addCollectionIds(String value)

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Parameters:

value - The collectionIds to add.

Returns:

This builder for chaining.

addAllCollectionIds

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

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Parameters:

values - The collectionIds to add.

Returns:

This builder for chaining.

clearCollectionIds

public ExportDocumentsRequest.Builder clearCollectionIds()

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Returns:

This builder for chaining.

addCollectionIdsBytes

public ExportDocumentsRequest.Builder addCollectionIdsBytes(com.google.protobuf.ByteString value)

 Which collection ids to export. Unspecified means all collections.
 

repeated string collection_ids = 2;

Parameters:

value - The bytes of the collectionIds to add.

Returns:

This builder for chaining.

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;

Specified by:

getOutputUriPrefix in interface ExportDocumentsRequestOrBuilder

Returns:

The outputUriPrefix.

getOutputUriPrefixBytes

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

Specified by:

getOutputUriPrefixBytes in interface ExportDocumentsRequestOrBuilder

Returns:

The bytes for outputUriPrefix.

setOutputUriPrefix

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;

Parameters:

value - The outputUriPrefix to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setOutputUriPrefixBytes

public ExportDocumentsRequest.Builder setOutputUriPrefixBytes(com.google.protobuf.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;

Parameters:

value - The bytes for outputUriPrefix to set.

Returns:

This builder for chaining.

setUnknownFields

public final ExportDocumentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>

mergeUnknownFields

public final ExportDocumentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExportDocumentsRequest.Builder>