FirestoreAdminClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.firestore.v1.FirestoreAdminClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class FirestoreAdminClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Operations are created by service `FirestoreAdmin`, but are accessed via service `google.longrunning.Operations`.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   Index index = Index.newBuilder().build();
   Operation response = firestoreAdminClient.createIndex(parent, index);
 }
 
 
```
Note: close() needs to be called on the firestoreAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of FirestoreAdminSettings to create(). For example:
To customize credentials:
```
 
 FirestoreAdminSettings firestoreAdminSettings =
     FirestoreAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FirestoreAdminClient firestoreAdminClient =
     FirestoreAdminClient.create(firestoreAdminSettings);
 
 
```
To customize the endpoint:
```
 
 FirestoreAdminSettings firestoreAdminSettings =
     FirestoreAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 FirestoreAdminClient firestoreAdminClient =
     FirestoreAdminClient.create(firestoreAdminSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FirestoreAdminClient.ListFieldsFixedSizeCollection`
`static class`	`FirestoreAdminClient.ListFieldsPage`
`static class`	`FirestoreAdminClient.ListFieldsPagedResponse`
`static class`	`FirestoreAdminClient.ListIndexesFixedSizeCollection`
`static class`	`FirestoreAdminClient.ListIndexesPage`
`static class`	`FirestoreAdminClient.ListIndexesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FirestoreAdminClient(FirestoreAdminSettings settings)` Constructs an instance of FirestoreAdminClient, using the given settings.
`protected`	`FirestoreAdminClient(FirestoreAdminStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static FirestoreAdminClient`	`create()` Constructs an instance of FirestoreAdminClient with default settings.
`static FirestoreAdminClient`	`create(FirestoreAdminSettings settings)` Constructs an instance of FirestoreAdminClient, using the given settings.
`static FirestoreAdminClient`	`create(FirestoreAdminStub stub)` Constructs an instance of FirestoreAdminClient, using the given stub for making calls.
`com.google.longrunning.Operation`	`createIndex(CreateIndexRequest request)` Creates a composite index.
`com.google.longrunning.Operation`	`createIndex(ParentName parent, Index index)` Creates a composite index.
`com.google.longrunning.Operation`	`createIndex(String parent, Index index)` Creates a composite index.
`com.google.api.gax.rpc.UnaryCallable<CreateIndexRequest,com.google.longrunning.Operation>`	`createIndexCallable()` Creates a composite index.
`void`	`deleteIndex(DeleteIndexRequest request)` Deletes a composite index.
`void`	`deleteIndex(IndexName name)` Deletes a composite index.
`void`	`deleteIndex(String name)` Deletes a composite index.
`com.google.api.gax.rpc.UnaryCallable<DeleteIndexRequest,Empty>`	`deleteIndexCallable()` Deletes a composite index.
`com.google.longrunning.Operation`	`exportDocuments(DatabaseName name)` Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`com.google.longrunning.Operation`	`exportDocuments(ExportDocumentsRequest request)` Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`com.google.longrunning.Operation`	`exportDocuments(String name)` Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`com.google.api.gax.rpc.UnaryCallable<ExportDocumentsRequest,com.google.longrunning.Operation>`	`exportDocumentsCallable()` Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`Field`	`getField(FieldName name)` Gets the metadata and configuration for a Field.
`Field`	`getField(GetFieldRequest request)` Gets the metadata and configuration for a Field.
`Field`	`getField(String name)` Gets the metadata and configuration for a Field.
`com.google.api.gax.rpc.UnaryCallable<GetFieldRequest,Field>`	`getFieldCallable()` Gets the metadata and configuration for a Field.
`Index`	`getIndex(GetIndexRequest request)` Gets a composite index.
`Index`	`getIndex(IndexName name)` Gets a composite index.
`Index`	`getIndex(String name)` Gets a composite index.
`com.google.api.gax.rpc.UnaryCallable<GetIndexRequest,Index>`	`getIndexCallable()` Gets a composite index.
`FirestoreAdminSettings`	`getSettings()`
`FirestoreAdminStub`	`getStub()`
`com.google.longrunning.Operation`	`importDocuments(DatabaseName name)` Imports documents into Google Cloud Firestore.
`com.google.longrunning.Operation`	`importDocuments(ImportDocumentsRequest request)` Imports documents into Google Cloud Firestore.
`com.google.longrunning.Operation`	`importDocuments(String name)` Imports documents into Google Cloud Firestore.
`com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation>`	`importDocumentsCallable()` Imports documents into Google Cloud Firestore.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`FirestoreAdminClient.ListFieldsPagedResponse`	`listFields(ListFieldsRequest request)` Lists the field configuration and metadata for this database.
`FirestoreAdminClient.ListFieldsPagedResponse`	`listFields(ParentName parent)` Lists the field configuration and metadata for this database.
`FirestoreAdminClient.ListFieldsPagedResponse`	`listFields(String parent)` Lists the field configuration and metadata for this database.
`com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,ListFieldsResponse>`	`listFieldsCallable()` Lists the field configuration and metadata for this database.
`com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse>`	`listFieldsPagedCallable()` Lists the field configuration and metadata for this database.
`FirestoreAdminClient.ListIndexesPagedResponse`	`listIndexes(ListIndexesRequest request)` Lists composite indexes.
`FirestoreAdminClient.ListIndexesPagedResponse`	`listIndexes(ParentName parent)` Lists composite indexes.
`FirestoreAdminClient.ListIndexesPagedResponse`	`listIndexes(String parent)` Lists composite indexes.
`com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,ListIndexesResponse>`	`listIndexesCallable()` Lists composite indexes.
`com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse>`	`listIndexesPagedCallable()` Lists composite indexes.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.longrunning.Operation`	`updateField(Field field)` Updates a field configuration.
`com.google.longrunning.Operation`	`updateField(UpdateFieldRequest request)` Updates a field configuration.
`com.google.api.gax.rpc.UnaryCallable<UpdateFieldRequest,com.google.longrunning.Operation>`	`updateFieldCallable()` Updates a field configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- FirestoreAdminClient
```
protected FirestoreAdminClient(FirestoreAdminSettings settings)
                        throws IOException
```
  Constructs an instance of FirestoreAdminClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- FirestoreAdminClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected FirestoreAdminClient(FirestoreAdminStub stub)
```

Method Detail

create

public static final FirestoreAdminClient create()
                                         throws IOException

Constructs an instance of FirestoreAdminClient with default settings.

Throws:: IOException

create
```
public static final FirestoreAdminClient create(FirestoreAdminSettings settings)
                                         throws IOException
```
Constructs an instance of FirestoreAdminClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final FirestoreAdminClient create(FirestoreAdminStub stub)

Constructs an instance of FirestoreAdminClient, using the given stub for making calls. This is for advanced usage - prefer to use FirestoreAdminSettings}.

getSettings

public final FirestoreAdminSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public FirestoreAdminStub getStub()

createIndex
```
public final com.google.longrunning.Operation createIndex(ParentName parent,
                                                          Index index)
```
Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   Index index = Index.newBuilder().build();
   Operation response = firestoreAdminClient.createIndex(parent, index);
 }
 
```
Parameters:

parent - A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`

index - The composite index to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createIndex
```
public final com.google.longrunning.Operation createIndex(String parent,
                                                          Index index)
```
Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   Index index = Index.newBuilder().build();
   Operation response = firestoreAdminClient.createIndex(parent.toString(), index);
 }
 
```
Parameters:

parent - A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`

index - The composite index to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createIndex

public final com.google.longrunning.Operation createIndex(CreateIndexRequest request)

Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   Index index = Index.newBuilder().build();
   CreateIndexRequest request = CreateIndexRequest.newBuilder()
     .setParent(parent.toString())
     .setIndex(index)
     .build();
   Operation response = firestoreAdminClient.createIndex(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createIndexCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateIndexRequest,com.google.longrunning.Operation> createIndexCallable()

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   Index index = Index.newBuilder().build();
   CreateIndexRequest request = CreateIndexRequest.newBuilder()
     .setParent(parent.toString())
     .setIndex(index)
     .build();
   ApiFuture<Operation> future = firestoreAdminClient.createIndexCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

listIndexes

public final FirestoreAdminClient.ListIndexesPagedResponse listIndexes(ParentName parent)

Lists composite indexes.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   for (Index element : firestoreAdminClient.listIndexes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listIndexes

public final FirestoreAdminClient.ListIndexesPagedResponse listIndexes(String parent)

Lists composite indexes.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   for (Index element : firestoreAdminClient.listIndexes(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listIndexes

public final FirestoreAdminClient.ListIndexesPagedResponse listIndexes(ListIndexesRequest request)

Lists composite indexes.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   ListIndexesRequest request = ListIndexesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Index element : firestoreAdminClient.listIndexes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listIndexesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesPagedCallable()

Lists composite indexes.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   ListIndexesRequest request = ListIndexesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListIndexesPagedResponse> future = firestoreAdminClient.listIndexesPagedCallable().futureCall(request);
   // Do something
   for (Index element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listIndexesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListIndexesRequest,ListIndexesResponse> listIndexesCallable()

Lists composite indexes.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   ListIndexesRequest request = ListIndexesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListIndexesResponse response = firestoreAdminClient.listIndexesCallable().call(request);
     for (Index element : response.getIndexesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getIndex

public final Index getIndex(IndexName name)

Gets a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   Index response = firestoreAdminClient.getIndex(name);
 }

Parameters:: name - A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getIndex

public final Index getIndex(String name)

Gets a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   Index response = firestoreAdminClient.getIndex(name.toString());
 }

Parameters:: name - A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getIndex

public final Index getIndex(GetIndexRequest request)

Gets a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   GetIndexRequest request = GetIndexRequest.newBuilder()
     .setName(name.toString())
     .build();
   Index response = firestoreAdminClient.getIndex(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getIndexCallable

public final com.google.api.gax.rpc.UnaryCallable<GetIndexRequest,Index> getIndexCallable()

Gets a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   GetIndexRequest request = GetIndexRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Index> future = firestoreAdminClient.getIndexCallable().futureCall(request);
   // Do something
   Index response = future.get();
 }

deleteIndex

public final void deleteIndex(IndexName name)

Deletes a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   firestoreAdminClient.deleteIndex(name);
 }

Parameters:: name - A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteIndex

public final void deleteIndex(String name)

Deletes a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   firestoreAdminClient.deleteIndex(name.toString());
 }

Parameters:: name - A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteIndex

public final void deleteIndex(DeleteIndexRequest request)

Deletes a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   DeleteIndexRequest request = DeleteIndexRequest.newBuilder()
     .setName(name.toString())
     .build();
   firestoreAdminClient.deleteIndex(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteIndexCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteIndexRequest,Empty> deleteIndexCallable()

Deletes a composite index.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   IndexName name = IndexName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]");
   DeleteIndexRequest request = DeleteIndexRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = firestoreAdminClient.deleteIndexCallable().futureCall(request);
   // Do something
   future.get();
 }

importDocuments
```
public final com.google.longrunning.Operation importDocuments(DatabaseName name)
```
Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   Operation response = firestoreAdminClient.importDocuments(name);
 }
 
```
Parameters:

name - Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importDocuments
```
public final com.google.longrunning.Operation importDocuments(String name)
```
Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   Operation response = firestoreAdminClient.importDocuments(name.toString());
 }
 
```
Parameters:

name - Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importDocuments
```
public final com.google.longrunning.Operation importDocuments(ImportDocumentsRequest request)
```
Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   ImportDocumentsRequest request = ImportDocumentsRequest.newBuilder()
     .setName(name.toString())
     .build();
   Operation response = firestoreAdminClient.importDocuments(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importDocumentsCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportDocumentsRequest,com.google.longrunning.Operation> importDocumentsCallable()

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   ImportDocumentsRequest request = ImportDocumentsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = firestoreAdminClient.importDocumentsCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

exportDocuments
```
public final com.google.longrunning.Operation exportDocuments(DatabaseName name)
```
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   Operation response = firestoreAdminClient.exportDocuments(name);
 }
 
```
Parameters:

name - Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportDocuments
```
public final com.google.longrunning.Operation exportDocuments(String name)
```
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   Operation response = firestoreAdminClient.exportDocuments(name.toString());
 }
 
```
Parameters:

name - Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportDocuments
```
public final com.google.longrunning.Operation exportDocuments(ExportDocumentsRequest request)
```
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   ExportDocumentsRequest request = ExportDocumentsRequest.newBuilder()
     .setName(name.toString())
     .build();
   Operation response = firestoreAdminClient.exportDocuments(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportDocumentsCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportDocumentsRequest,com.google.longrunning.Operation> exportDocumentsCallable()

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[DATABASE]");
   ExportDocumentsRequest request = ExportDocumentsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Operation> future = firestoreAdminClient.exportDocumentsCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getField

public final Field getField(FieldName name)

Gets the metadata and configuration for a Field.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   FieldName name = FieldName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[FIELD_ID]");
   Field response = firestoreAdminClient.getField(name);
 }

Parameters:: name - A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getField

public final Field getField(String name)

Gets the metadata and configuration for a Field.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   FieldName name = FieldName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[FIELD_ID]");
   Field response = firestoreAdminClient.getField(name.toString());
 }

Parameters:: name - A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getField

public final Field getField(GetFieldRequest request)

Gets the metadata and configuration for a Field.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   FieldName name = FieldName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[FIELD_ID]");
   GetFieldRequest request = GetFieldRequest.newBuilder()
     .setName(name.toString())
     .build();
   Field response = firestoreAdminClient.getField(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getFieldCallable

public final com.google.api.gax.rpc.UnaryCallable<GetFieldRequest,Field> getFieldCallable()

Gets the metadata and configuration for a Field.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   FieldName name = FieldName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[FIELD_ID]");
   GetFieldRequest request = GetFieldRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Field> future = firestoreAdminClient.getFieldCallable().futureCall(request);
   // Do something
   Field response = future.get();
 }

listFields
```
public final FirestoreAdminClient.ListFieldsPagedResponse listFields(ParentName parent)
```
Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false`.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   for (Field element : firestoreAdminClient.listFields(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFields
```
public final FirestoreAdminClient.ListFieldsPagedResponse listFields(String parent)
```
Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false`.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   for (Field element : firestoreAdminClient.listFields(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFields
```
public final FirestoreAdminClient.ListFieldsPagedResponse listFields(ListFieldsRequest request)
```
Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false`.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   ListFieldsRequest request = ListFieldsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Field element : firestoreAdminClient.listFields(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listFieldsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsPagedCallable()

Lists the field configuration and metadata for this database.

Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to `indexConfig.usesAncestorConfig:false`.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   ListFieldsRequest request = ListFieldsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListFieldsPagedResponse> future = firestoreAdminClient.listFieldsPagedCallable().futureCall(request);
   // Do something
   for (Field element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listFieldsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFieldsRequest,ListFieldsResponse> listFieldsCallable()

Lists the field configuration and metadata for this database.

Sample code:


 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   ParentName parent = ParentName.of("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]");
   ListFieldsRequest request = ListFieldsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListFieldsResponse response = firestoreAdminClient.listFieldsCallable().call(request);
     for (Field element : response.getFieldsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

updateField
```
public final com.google.longrunning.Operation updateField(Field field)
```
Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   Field field = Field.newBuilder().build();
   Operation response = firestoreAdminClient.updateField(field);
 }
 
```
Parameters:

field - The field to be updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateField
```
public final com.google.longrunning.Operation updateField(UpdateFieldRequest request)
```
Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   Field field = Field.newBuilder().build();
   UpdateFieldRequest request = UpdateFieldRequest.newBuilder()
     .setField(field)
     .build();
   Operation response = firestoreAdminClient.updateField(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateFieldCallable
```
public final com.google.api.gax.rpc.UnaryCallable<UpdateFieldRequest,com.google.longrunning.Operation> updateFieldCallable()
```
Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
Sample code:
```
 try (FirestoreAdminClient firestoreAdminClient = FirestoreAdminClient.create()) {
   Field field = Field.newBuilder().build();
   UpdateFieldRequest request = UpdateFieldRequest.newBuilder()
     .setField(field)
     .build();
   ApiFuture<Operation> future = firestoreAdminClient.updateFieldCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 
```

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class FirestoreAdminClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FirestoreAdminClient

FirestoreAdminClient

Method Detail

create

create

create

getSettings

getStub

createIndex

createIndex

createIndex

createIndexCallable

listIndexes

listIndexes

listIndexes

listIndexesPagedCallable

listIndexesCallable

getIndex

getIndex

getIndex

getIndexCallable

deleteIndex

deleteIndex

deleteIndex

deleteIndexCallable

importDocuments

importDocuments

importDocuments

importDocumentsCallable

exportDocuments

exportDocuments

exportDocuments

exportDocumentsCallable

getField

getField

getField

getFieldCallable

listFields

listFields

listFields

listFieldsPagedCallable

listFieldsCallable

updateField

updateField

updateFieldCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination