com.google.cloud.firestore.v1

Class FirestoreAdminSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<FirestoreAdminSettings>

com.google.cloud.firestore.v1.FirestoreAdminSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class FirestoreAdminSettings
extends ClientSettings<FirestoreAdminSettings>

Settings class to configure an instance of FirestoreAdminClient.

The default instance has everything set to sensible defaults:

• The default service address (firestore.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object. For example, to set the total timeout of createIndex to 30 seconds:

 
 FirestoreAdminSettings.Builder firestoreAdminSettingsBuilder =
     FirestoreAdminSettings.newBuilder();
 firestoreAdminSettingsBuilder.createIndexSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 FirestoreAdminSettings firestoreAdminSettings = firestoreAdminSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirestoreAdminSettings.Builder Builder for FirestoreAdminSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FirestoreAdminSettings(FirestoreAdminSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static FirestoreAdminSettings	create(FirestoreAdminStubSettings stub)
UnaryCallSettings<com.google.firestore.admin.v1.CreateIndexRequest,Operation>	createIndexSettings() Returns the object with the settings used for calls to createIndex.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.firestore.admin.v1.DeleteIndexRequest,Empty>	deleteIndexSettings() Returns the object with the settings used for calls to deleteIndex.
UnaryCallSettings<com.google.firestore.admin.v1.ExportDocumentsRequest,Operation>	exportDocumentsSettings() Returns the object with the settings used for calls to exportDocuments.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.firestore.admin.v1.GetFieldRequest,com.google.firestore.admin.v1.Field>	getFieldSettings() Returns the object with the settings used for calls to getField.
UnaryCallSettings<com.google.firestore.admin.v1.GetIndexRequest,com.google.firestore.admin.v1.Index>	getIndexSettings() Returns the object with the settings used for calls to getIndex.
UnaryCallSettings<com.google.firestore.admin.v1.ImportDocumentsRequest,Operation>	importDocumentsSettings() Returns the object with the settings used for calls to importDocuments.
PagedCallSettings<com.google.firestore.admin.v1.ListFieldsRequest,com.google.firestore.admin.v1.ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse>	listFieldsSettings() Returns the object with the settings used for calls to listFields.
PagedCallSettings<com.google.firestore.admin.v1.ListIndexesRequest,com.google.firestore.admin.v1.ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse>	listIndexesSettings() Returns the object with the settings used for calls to listIndexes.
static FirestoreAdminSettings.Builder	newBuilder() Returns a new builder for this class.
static FirestoreAdminSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
FirestoreAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.firestore.admin.v1.UpdateFieldRequest,Operation>	updateFieldSettings() Returns the object with the settings used for calls to updateField.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FirestoreAdminSettings

protected FirestoreAdminSettings(FirestoreAdminSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

createIndexSettings

public UnaryCallSettings<com.google.firestore.admin.v1.CreateIndexRequest,Operation> createIndexSettings()

Returns the object with the settings used for calls to createIndex.

listIndexesSettings

public PagedCallSettings<com.google.firestore.admin.v1.ListIndexesRequest,com.google.firestore.admin.v1.ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesSettings()

Returns the object with the settings used for calls to listIndexes.

getIndexSettings

public UnaryCallSettings<com.google.firestore.admin.v1.GetIndexRequest,com.google.firestore.admin.v1.Index> getIndexSettings()

Returns the object with the settings used for calls to getIndex.

deleteIndexSettings

public UnaryCallSettings<com.google.firestore.admin.v1.DeleteIndexRequest,Empty> deleteIndexSettings()

Returns the object with the settings used for calls to deleteIndex.

importDocumentsSettings

public UnaryCallSettings<com.google.firestore.admin.v1.ImportDocumentsRequest,Operation> importDocumentsSettings()

Returns the object with the settings used for calls to importDocuments.

exportDocumentsSettings

public UnaryCallSettings<com.google.firestore.admin.v1.ExportDocumentsRequest,Operation> exportDocumentsSettings()

Returns the object with the settings used for calls to exportDocuments.

getFieldSettings

public UnaryCallSettings<com.google.firestore.admin.v1.GetFieldRequest,com.google.firestore.admin.v1.Field> getFieldSettings()

Returns the object with the settings used for calls to getField.

listFieldsSettings

public PagedCallSettings<com.google.firestore.admin.v1.ListFieldsRequest,com.google.firestore.admin.v1.ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsSettings()

Returns the object with the settings used for calls to listFields.

updateFieldSettings

public UnaryCallSettings<com.google.firestore.admin.v1.UpdateFieldRequest,Operation> updateFieldSettings()

Returns the object with the settings used for calls to updateField.

create

public static final FirestoreAdminSettings create(FirestoreAdminStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static FirestoreAdminSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static FirestoreAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public FirestoreAdminSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class ClientSettings<FirestoreAdminSettings>