Class ImportDocumentsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
com.google.firestore.admin.v1.ImportDocumentsRequest.Builder
All Implemented Interfaces:
ImportDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ImportDocumentsRequest

public static final class ImportDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder> implements ImportDocumentsRequestOrBuilder
 The request for
 [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
 
Protobuf type google.firestore.admin.v1.ImportDocumentsRequest
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
    • getDefaultInstanceForType

      public ImportDocumentsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public ImportDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ImportDocumentsRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
    • mergeFrom

      public ImportDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ImportDocumentsRequest.Builder>
      Throws:
      IOException
    • 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.
    • setName

      public ImportDocumentsRequest.Builder setName(String value)
       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) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

      public ImportDocumentsRequest.Builder clearName()
       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:
      This builder for chaining.
    • setNameBytes

      public ImportDocumentsRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • getCollectionIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getCollectionIdsList in interface ImportDocumentsRequestOrBuilder
      Returns:
      A list containing the collectionIds.
    • getCollectionIdsCount

      public 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;
      Specified by:
      getCollectionIdsCount in interface ImportDocumentsRequestOrBuilder
      Returns:
      The count of collectionIds.
    • getCollectionIds

      public 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;
      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)
       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;
      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.
    • setCollectionIds

      public ImportDocumentsRequest.Builder setCollectionIds(int index, String value)
       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 to set the value at.
      value - The collectionIds to set.
      Returns:
      This builder for chaining.
    • addCollectionIds

      public ImportDocumentsRequest.Builder addCollectionIds(String value)
       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:
      value - The collectionIds to add.
      Returns:
      This builder for chaining.
    • addAllCollectionIds

      public ImportDocumentsRequest.Builder addAllCollectionIds(Iterable<String> values)
       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:
      values - The collectionIds to add.
      Returns:
      This builder for chaining.
    • clearCollectionIds

      public ImportDocumentsRequest.Builder clearCollectionIds()
       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:
      This builder for chaining.
    • addCollectionIdsBytes

      public ImportDocumentsRequest.Builder addCollectionIdsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the collectionIds to add.
      Returns:
      This builder for chaining.
    • 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.
    • setInputUriPrefix

      public ImportDocumentsRequest.Builder setInputUriPrefix(String value)
       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;
      Parameters:
      value - The inputUriPrefix to set.
      Returns:
      This builder for chaining.
    • clearInputUriPrefix

      public ImportDocumentsRequest.Builder clearInputUriPrefix()
       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:
      This builder for chaining.
    • setInputUriPrefixBytes

      public ImportDocumentsRequest.Builder setInputUriPrefixBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for inputUriPrefix to set.
      Returns:
      This builder for chaining.
    • 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.
    • setNamespaceIds

      public ImportDocumentsRequest.Builder setNamespaceIds(int index, String value)
       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 to set the value at.
      value - The namespaceIds to set.
      Returns:
      This builder for chaining.
    • addNamespaceIds

      public ImportDocumentsRequest.Builder addNamespaceIds(String value)
       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:
      value - The namespaceIds to add.
      Returns:
      This builder for chaining.
    • addAllNamespaceIds

      public ImportDocumentsRequest.Builder addAllNamespaceIds(Iterable<String> values)
       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:
      values - The namespaceIds to add.
      Returns:
      This builder for chaining.
    • clearNamespaceIds

      public ImportDocumentsRequest.Builder clearNamespaceIds()
       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:
      This builder for chaining.
    • addNamespaceIdsBytes

      public ImportDocumentsRequest.Builder addNamespaceIdsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the namespaceIds to add.
      Returns:
      This builder for chaining.