Package com.google.firestore.admin.v1

Interface ImportDocumentsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ImportDocumentsRequest, ImportDocumentsRequest.Builder
@Generated public interface ImportDocumentsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCollectionIds(int index)
    IDs of the collection groups to import.
    com.google.protobuf.ByteString
    getCollectionIdsBytes(int index)
    IDs of the collection groups to import.
    int
    getCollectionIdsCount()
    IDs of the collection groups to import.
    List<String>
    getCollectionIdsList()
    IDs of the collection groups to import.
    String
    getInputUriPrefix()
    Location of the exported files.
    com.google.protobuf.ByteString
    getInputUriPrefixBytes()
    Location of the exported files.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    String
    getNamespaceIds(int index)
    An empty list represents all namespaces.
    com.google.protobuf.ByteString
    getNamespaceIdsBytes(int index)
    An empty list represents all namespaces.
    int
    getNamespaceIdsCount()
    An empty list represents all namespaces.
    List<String>
    getNamespaceIdsList()
    An empty list represents all namespaces.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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) = { ... }
      Returns:
      The bytes for name.

    • getCollectionIdsList

      List<String> getCollectionIdsList()
       IDs of the collection groups to import. Unspecified means all collection
 groups that were included in the export. Each collection group in this list
 must be unique.
      repeated string collection_ids = 2;
      Returns:
      A list containing the collectionIds.

    • getCollectionIdsCount

      int getCollectionIdsCount()
       IDs of the collection groups to import. Unspecified means all collection
 groups that were included in the export. Each collection group in this list
 must be unique.
      repeated string collection_ids = 2;
      Returns:
      The count of collectionIds.

    • getCollectionIds

      String getCollectionIds(int index)
       IDs of the collection groups to import. Unspecified means all collection
 groups that were included in the export. Each collection group in this list
 must be unique.
      repeated string collection_ids = 2;
      Parameters:
      index - The index of the element to return.
      Returns:
      The collectionIds at the given index.

    • getCollectionIdsBytes

      com.google.protobuf.ByteString getCollectionIdsBytes(int index)
       IDs of the collection groups to import. Unspecified means all collection
 groups that were included in the export. Each collection group in this list
 must be unique.
      repeated string collection_ids = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the collectionIds at the given index.

    • getInputUriPrefix

      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;
      Returns:
      The inputUriPrefix.

    • getInputUriPrefixBytes

      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;
      Returns:
      The bytes for inputUriPrefix.

    • getNamespaceIdsList

      List<String> 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;
      Returns:
      A list containing the namespaceIds.

    • getNamespaceIdsCount

      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:
      The count of namespaceIds.

    • getNamespaceIds

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The namespaceIds at the given index.

    • getNamespaceIdsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the namespaceIds at the given index.