Send feedback
Class ExportDocumentsRequest (3.15.3)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.15.3 keyboard_arrow_down
public final class ExportDocumentsRequest extends GeneratedMessageV3 implements ExportDocumentsRequestOrBuilder
The request for
FirestoreAdmin.ExportDocuments .
Protobuf type google.firestore.admin.v1.ExportDocumentsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
COLLECTION_IDS_FIELD_NUMBER
public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value Type Description int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value Type Description int
OUTPUT_URI_PREFIX_FIELD_NUMBER
public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static ExportDocumentsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ExportDocumentsRequest . Builder newBuilder ()
newBuilder(ExportDocumentsRequest prototype)
public static ExportDocumentsRequest . Builder newBuilder ( ExportDocumentsRequest prototype )
public static ExportDocumentsRequest parseDelimitedFrom ( InputStream input )
public static ExportDocumentsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ExportDocumentsRequest parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ExportDocumentsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ExportDocumentsRequest parseFrom ( CodedInputStream input )
public static ExportDocumentsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ExportDocumentsRequest parseFrom ( InputStream input )
public static ExportDocumentsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ExportDocumentsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ExportDocumentsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
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 indexint 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 indexint 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;
getDefaultInstanceForType()
public ExportDocumentsRequest getDefaultInstanceForType ()
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.
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.
getParserForType()
public Parser<ExportDocumentsRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ExportDocumentsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportDocumentsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public ExportDocumentsRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
