Class ImportDocumentsRequest (3.2.0)

public final class ImportDocumentsRequest extends GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder

The request for FirestoreAdmin.ImportDocuments.

Protobuf type google.firestore.admin.v1.ImportDocumentsRequest

Static Fields

COLLECTION_IDS_FIELD_NUMBER

public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_URI_PREFIX_FIELD_NUMBER

public static final int INPUT_URI_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportDocumentsRequest getDefaultInstance()
Returns
TypeDescription
ImportDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportDocumentsRequest.Builder newBuilder()
Returns
TypeDescription
ImportDocumentsRequest.Builder

newBuilder(ImportDocumentsRequest prototype)

public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)
Parameter
NameDescription
prototypeImportDocumentsRequest
Returns
TypeDescription
ImportDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportDocumentsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportDocumentsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportDocumentsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportDocumentsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportDocumentsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportDocumentsRequest> parser()
Returns
TypeDescription
Parser<ImportDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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;

Returns
TypeDescription
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public ImportDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportDocumentsRequest

getInputUriPrefix()

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
TypeDescription
String

The inputUriPrefix.

getInputUriPrefixBytes()

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
TypeDescription
ByteString

The bytes for inputUriPrefix.

getName()

public String 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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ImportDocumentsRequest> getParserForType()
Returns
TypeDescription
Parser<ImportDocumentsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ImportDocumentsRequest.Builder newBuilderForType()
Returns
TypeDescription
ImportDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ImportDocumentsRequest.Builder toBuilder()
Returns
TypeDescription
ImportDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException