Send feedback
Class ImportDocumentsRequest (3.20.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.20.0 keyboard_arrow_down
public final class ImportDocumentsRequest extends GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder
The request for
FirestoreAdmin.ImportDocuments .
Protobuf type google.firestore.admin.v1.ImportDocumentsRequest
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>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLLECTION_IDS_FIELD_NUMBER
public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value Type Description int
public static final int INPUT_URI_PREFIX_FIELD_NUMBER
Field Value Type Description int
NAMESPACE_IDS_FIELD_NUMBER
public static final int NAMESPACE_IDS_FIELD_NUMBER
Field Value Type Description int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static ImportDocumentsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ImportDocumentsRequest . Builder newBuilder ()
newBuilder(ImportDocumentsRequest prototype)
public static ImportDocumentsRequest . Builder newBuilder ( ImportDocumentsRequest prototype )
public static ImportDocumentsRequest parseDelimitedFrom ( InputStream input )
public static ImportDocumentsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ImportDocumentsRequest parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ImportDocumentsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsRequest parseFrom ( CodedInputStream input )
public static ImportDocumentsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsRequest parseFrom ( InputStream input )
public static ImportDocumentsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ImportDocumentsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ImportDocumentsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides
getCollectionIds(int index)
public String getCollectionIds ( int index )
Which collection ids to import. Unspecified means all collections included
in the import.
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 import. Unspecified means all collections included
in the import.
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 import. Unspecified means all collections included
in the import.
repeated string collection_ids = 2;
Returns Type Description int
The count of collectionIds.
getCollectionIdsList()
public ProtocolStringList getCollectionIdsList ()
Which collection ids to import. Unspecified means all collections included
in the import.
repeated string collection_ids = 2;
getDefaultInstanceForType()
public ImportDocumentsRequest getDefaultInstanceForType ()
public String getInputUriPrefix ()
Location of the exported files.
This must match the output_uri_prefix of an ExportDocumentsResponse from
an export that has completed successfully.
See:
google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix .
string input_uri_prefix = 3;
Returns Type Description String
The inputUriPrefix.
public ByteString getInputUriPrefixBytes ()
Location of the exported files.
This must match the output_uri_prefix of an ExportDocumentsResponse from
an export that has completed successfully.
See:
google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix .
string input_uri_prefix = 3;
Returns Type Description ByteString
The bytes for inputUriPrefix.
getName()
Required. Database to import into. 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 import into. 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;
getParserForType()
public Parser<ImportDocumentsRequest> 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 ImportDocumentsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ImportDocumentsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public ImportDocumentsRequest . 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-28 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-28 UTC."],[],[]]