Package com.google.firestore.admin.v1
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 Summary
Modifier and TypeMethodDescriptionaddAllCollectionIds(Iterable<String> values) IDs of the collection groups to import.addAllNamespaceIds(Iterable<String> values) An empty list represents all namespaces.addCollectionIds(String value) IDs of the collection groups to import.addCollectionIdsBytes(com.google.protobuf.ByteString value) IDs of the collection groups to import.addNamespaceIds(String value) An empty list represents all namespaces.addNamespaceIdsBytes(com.google.protobuf.ByteString value) An empty list represents all namespaces.build()clear()IDs of the collection groups to import.Location of the exported files.Required.An empty list represents all namespaces.getCollectionIds(int index) IDs of the collection groups to import.com.google.protobuf.ByteStringgetCollectionIdsBytes(int index) IDs of the collection groups to import.intIDs of the collection groups to import.com.google.protobuf.ProtocolStringListIDs of the collection groups to import.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorLocation of the exported files.com.google.protobuf.ByteStringLocation of the exported files.getName()Required.com.google.protobuf.ByteStringRequired.getNamespaceIds(int index) An empty list represents all namespaces.com.google.protobuf.ByteStringgetNamespaceIdsBytes(int index) An empty list represents all namespaces.intAn empty list represents all namespaces.com.google.protobuf.ProtocolStringListAn empty list represents all namespaces.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(ImportDocumentsRequest other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) setCollectionIds(int index, String value) IDs of the collection groups to import.setInputUriPrefix(String value) Location of the exported files.setInputUriPrefixBytes(com.google.protobuf.ByteString value) Location of the exported files.Required.setNameBytes(com.google.protobuf.ByteString value) Required.setNamespaceIds(int index, String value) An empty list represents all namespaces.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<ImportDocumentsRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ImportDocumentsRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ImportDocumentsRequest.Builder>- Throws:
IOException
-
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:
getNamein interfaceImportDocumentsRequestOrBuilder- 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:
getNameBytesin interfaceImportDocumentsRequestOrBuilder- Returns:
- The bytes for name.
-
setName
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
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
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:
getCollectionIdsListin interfaceImportDocumentsRequestOrBuilder- 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:
getCollectionIdsCountin interfaceImportDocumentsRequestOrBuilder- Returns:
- The count of collectionIds.
-
getCollectionIds
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:
getCollectionIdsin interfaceImportDocumentsRequestOrBuilder- 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:
getCollectionIdsBytesin interfaceImportDocumentsRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the collectionIds at the given index.
-
setCollectionIds
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
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
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
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
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
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:
getInputUriPrefixin interfaceImportDocumentsRequestOrBuilder- 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:
getInputUriPrefixBytesin interfaceImportDocumentsRequestOrBuilder- Returns:
- The bytes for inputUriPrefix.
-
setInputUriPrefix
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
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
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:
getNamespaceIdsListin interfaceImportDocumentsRequestOrBuilder- 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:
getNamespaceIdsCountin interfaceImportDocumentsRequestOrBuilder- Returns:
- The count of namespaceIds.
-
getNamespaceIds
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:
getNamespaceIdsin interfaceImportDocumentsRequestOrBuilder- 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:
getNamespaceIdsBytesin interfaceImportDocumentsRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the namespaceIds at the given index.
-
setNamespaceIds
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
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
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
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
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.
-