com.google.firestore.admin.v1

Class ExportDocumentsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.admin.v1.ExportDocumentsRequest

All Implemented Interfaces:

ExportDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ExportDocumentsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ExportDocumentsRequestOrBuilder

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

Protobuf type google.firestore.admin.v1.ExportDocumentsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportDocumentsRequest.Builder The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLLECTION_IDS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	OUTPUT_URI_PREFIX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static ExportDocumentsRequest	getDefaultInstance()
ExportDocumentsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getOutputUriPrefix() The output URI.
com.google.protobuf.ByteString	getOutputUriPrefixBytes() The output URI.
com.google.protobuf.Parser<ExportDocumentsRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExportDocumentsRequest.Builder	newBuilder()
static ExportDocumentsRequest.Builder	newBuilder(ExportDocumentsRequest prototype)
ExportDocumentsRequest.Builder	newBuilderForType()
protected ExportDocumentsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExportDocumentsRequest	parseDelimitedFrom(InputStream input)
static ExportDocumentsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportDocumentsRequest	parseFrom(byte[] data)
static ExportDocumentsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportDocumentsRequest	parseFrom(ByteBuffer data)
static ExportDocumentsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportDocumentsRequest	parseFrom(com.google.protobuf.ByteString data)
static ExportDocumentsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportDocumentsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ExportDocumentsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExportDocumentsRequest	parseFrom(InputStream input)
static ExportDocumentsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExportDocumentsRequest>	parser()
ExportDocumentsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

COLLECTION_IDS_FIELD_NUMBER

public static final int COLLECTION_IDS_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_URI_PREFIX_FIELD_NUMBER

public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ExportDocumentsRequest parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportDocumentsRequest parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportDocumentsRequest parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportDocumentsRequest parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportDocumentsRequest parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportDocumentsRequest parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExportDocumentsRequest parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static ExportDocumentsRequest parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExportDocumentsRequest parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExportDocumentsRequest parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static ExportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static ExportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public ExportDocumentsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExportDocumentsRequest.Builder newBuilder()

newBuilder

public static ExportDocumentsRequest.Builder newBuilder(ExportDocumentsRequest prototype)

toBuilder

public ExportDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExportDocumentsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExportDocumentsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ExportDocumentsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ExportDocumentsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ExportDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder