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-java")
public class FirestoreAdminSettings
extends com.google.api.gax.rpc.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 getIndex to 30 seconds:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FirestoreAdminSettings.Builder firestoreAdminSettingsBuilder =
     FirestoreAdminSettings.newBuilder();
 firestoreAdminSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         firestoreAdminSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 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)
com.google.api.gax.rpc.OperationCallSettings<CreateIndexRequest,Index,IndexOperationMetadata>	createIndexOperationSettings() Returns the object with the settings used for calls to createIndex.
com.google.api.gax.rpc.UnaryCallSettings<CreateIndexRequest,com.google.longrunning.Operation>	createIndexSettings() Returns the object with the settings used for calls to createIndex.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexRequest,com.google.protobuf.Empty>	deleteIndexSettings() Returns the object with the settings used for calls to deleteIndex.
com.google.api.gax.rpc.OperationCallSettings<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata>	exportDocumentsOperationSettings() Returns the object with the settings used for calls to exportDocuments.
com.google.api.gax.rpc.UnaryCallSettings<ExportDocumentsRequest,com.google.longrunning.Operation>	exportDocumentsSettings() Returns the object with the settings used for calls to exportDocuments.
com.google.api.gax.rpc.UnaryCallSettings<GetDatabaseRequest,Database>	getDatabaseSettings() Returns the object with the settings used for calls to getDatabase.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetFieldRequest,Field>	getFieldSettings() Returns the object with the settings used for calls to getField.
com.google.api.gax.rpc.UnaryCallSettings<GetIndexRequest,Index>	getIndexSettings() Returns the object with the settings used for calls to getIndex.
com.google.api.gax.rpc.OperationCallSettings<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata>	importDocumentsOperationSettings() Returns the object with the settings used for calls to importDocuments.
com.google.api.gax.rpc.UnaryCallSettings<ImportDocumentsRequest,com.google.longrunning.Operation>	importDocumentsSettings() Returns the object with the settings used for calls to importDocuments.
com.google.api.gax.rpc.UnaryCallSettings<ListDatabasesRequest,ListDatabasesResponse>	listDatabasesSettings() Returns the object with the settings used for calls to listDatabases.
com.google.api.gax.rpc.PagedCallSettings<ListFieldsRequest,ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse>	listFieldsSettings() Returns the object with the settings used for calls to listFields.
com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse>	listIndexesSettings() Returns the object with the settings used for calls to listIndexes.
static FirestoreAdminSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static FirestoreAdminSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static FirestoreAdminSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
FirestoreAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata>	updateDatabaseOperationSettings() Returns the object with the settings used for calls to updateDatabase.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDatabaseRequest,com.google.longrunning.Operation>	updateDatabaseSettings() Returns the object with the settings used for calls to updateDatabase.
com.google.api.gax.rpc.OperationCallSettings<UpdateFieldRequest,Field,FieldOperationMetadata>	updateFieldOperationSettings() Returns the object with the settings used for calls to updateField.
com.google.api.gax.rpc.UnaryCallSettings<UpdateFieldRequest,com.google.longrunning.Operation>	updateFieldSettings() Returns the object with the settings used for calls to updateField.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, 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 com.google.api.gax.rpc.UnaryCallSettings<CreateIndexRequest,com.google.longrunning.Operation> createIndexSettings()

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

createIndexOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateIndexRequest,Index,IndexOperationMetadata> createIndexOperationSettings()

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

listIndexesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,FirestoreAdminClient.ListIndexesPagedResponse> listIndexesSettings()

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

getIndexSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()

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

deleteIndexSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexRequest,com.google.protobuf.Empty> deleteIndexSettings()

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

getFieldSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetFieldRequest,Field> getFieldSettings()

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

updateFieldSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateFieldRequest,com.google.longrunning.Operation> updateFieldSettings()

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

updateFieldOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateFieldRequest,Field,FieldOperationMetadata> updateFieldOperationSettings()

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

listFieldsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListFieldsRequest,ListFieldsResponse,FirestoreAdminClient.ListFieldsPagedResponse> listFieldsSettings()

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

exportDocumentsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExportDocumentsRequest,com.google.longrunning.Operation> exportDocumentsSettings()

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

exportDocumentsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ExportDocumentsRequest,ExportDocumentsResponse,ExportDocumentsMetadata> exportDocumentsOperationSettings()

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

importDocumentsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportDocumentsRequest,com.google.longrunning.Operation> importDocumentsSettings()

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

importDocumentsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportDocumentsRequest,com.google.protobuf.Empty,ImportDocumentsMetadata> importDocumentsOperationSettings()

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

getDatabaseSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDatabaseRequest,Database> getDatabaseSettings()

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

listDatabasesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ListDatabasesRequest,ListDatabasesResponse> listDatabasesSettings()

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

updateDatabaseSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDatabaseRequest,com.google.longrunning.Operation> updateDatabaseSettings()

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

updateDatabaseOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateDatabaseRequest,Database,UpdateDatabaseMetadata> updateDatabaseOperationSettings()

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

create

public static final FirestoreAdminSettings create(FirestoreAdminStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static FirestoreAdminSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static FirestoreAdminSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static FirestoreAdminSettings.Builder newBuilder(com.google.api.gax.rpc.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 com.google.api.gax.rpc.ClientSettings<FirestoreAdminSettings>