Package com.google.firestore.admin.v1

Class ImportDocumentsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.admin.v1.ImportDocumentsRequest
All Implemented Interfaces:
ImportDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ImportDocumentsRequest extends com.google.protobuf.GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder
 The request for
 [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
Protobuf type google.firestore.admin.v1.ImportDocumentsRequest
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • COLLECTION_IDS_FIELD_NUMBER

      public static final int COLLECTION_IDS_FIELD_NUMBER
      See Also:

    • INPUT_URI_PREFIX_FIELD_NUMBER

      public static final int INPUT_URI_PREFIX_FIELD_NUMBER
      See Also:

    • NAMESPACE_IDS_FIELD_NUMBER

      public static final int NAMESPACE_IDS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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 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) = { ... }
      Specified by:
      getName in interface ImportDocumentsRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getNameBytes in interface ImportDocumentsRequestOrBuilder
      Returns:
      The bytes for name.

    • getCollectionIdsList

      public com.google.protobuf.ProtocolStringList getCollectionIdsList()
       Which collection IDs to import. Unspecified means all collections included
 in the import. Each collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIdsList in interface ImportDocumentsRequestOrBuilder
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      public int getCollectionIdsCount()
       Which collection IDs to import. Unspecified means all collections included
 in the import. Each collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIdsCount in interface ImportDocumentsRequestOrBuilder
      Returns:
      The count of collectionIds.

    • getCollectionIds

      public String getCollectionIds(int index)
       Which collection IDs to import. Unspecified means all collections included
 in the import. Each collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIds in interface ImportDocumentsRequestOrBuilder
      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 import. Unspecified means all collections included
 in the import. Each collection ID in this list must be unique.
      repeated string collection_ids = 2;
      Specified by:
      getCollectionIdsBytes in interface ImportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • 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][google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix].
      string input_uri_prefix = 3;
      Specified by:
      getInputUriPrefix in interface ImportDocumentsRequestOrBuilder
      Returns:
      The inputUriPrefix.

    • getInputUriPrefixBytes

      public com.google.protobuf.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][google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix].
      string input_uri_prefix = 3;
      Specified by:
      getInputUriPrefixBytes in interface ImportDocumentsRequestOrBuilder
      Returns:
      The bytes for inputUriPrefix.

    • getNamespaceIdsList

      public com.google.protobuf.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;
      Specified by:
      getNamespaceIdsList in interface ImportDocumentsRequestOrBuilder
      Returns:
      A list containing the namespaceIds.

    • 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;
      Specified by:
      getNamespaceIdsCount in interface ImportDocumentsRequestOrBuilder
      Returns:
      The count of namespaceIds.

    • getNamespaceIds

      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;
      Specified by:
      getNamespaceIds in interface ImportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      public com.google.protobuf.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;
      Specified by:
      getNamespaceIdsBytes in interface ImportDocumentsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.

    • 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 ImportDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ImportDocumentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ImportDocumentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ImportDocumentsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ImportDocumentsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ImportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public ImportDocumentsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ImportDocumentsRequest.Builder newBuilder()

    • newBuilder

      public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)

    • toBuilder

      public ImportDocumentsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ImportDocumentsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ImportDocumentsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ImportDocumentsRequest> 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 ImportDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder