Package com.google.cloud.datastore.admin.v1

Class DatastoreAdminSettings

java.lang.Object
com.google.api.gax.rpc.ClientSettings<DatastoreAdminSettings>
com.google.cloud.datastore.admin.v1.DatastoreAdminSettings
@Generated("by gapic-generator-java") public class DatastoreAdminSettings extends com.google.api.gax.rpc.ClientSettings<DatastoreAdminSettings>
Settings class to configure an instance of DatastoreAdminClient.

The default instance has everything set to sensible defaults:

  • The default service address (datastore.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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getIndex: 


 // 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
 DatastoreAdminSettings.Builder datastoreAdminSettingsBuilder =
     DatastoreAdminSettings.newBuilder();
 datastoreAdminSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         datastoreAdminSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 DatastoreAdminSettings datastoreAdminSettings = datastoreAdminSettingsBuilder.build();
Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for exportEntities: 


 // 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
 DatastoreAdminSettings.Builder datastoreAdminSettingsBuilder =
     DatastoreAdminSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 datastoreAdminSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

  • Constructor Details

  • Method Details

    • exportEntitiesSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ExportEntitiesRequest,com.google.longrunning.Operation> exportEntitiesSettings()
      Returns the object with the settings used for calls to exportEntities.

    • exportEntitiesOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<ExportEntitiesRequest,ExportEntitiesResponse,ExportEntitiesMetadata> exportEntitiesOperationSettings()
      Returns the object with the settings used for calls to exportEntities.

    • importEntitiesSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ImportEntitiesRequest,com.google.longrunning.Operation> importEntitiesSettings()
      Returns the object with the settings used for calls to importEntities.

    • importEntitiesOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<ImportEntitiesRequest,com.google.protobuf.Empty,ImportEntitiesMetadata> importEntitiesOperationSettings()
      Returns the object with the settings used for calls to importEntities.

    • 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.

    • deleteIndexSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexRequest,com.google.longrunning.Operation> deleteIndexSettings()
      Returns the object with the settings used for calls to deleteIndex.

    • deleteIndexOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<DeleteIndexRequest,Index,IndexOperationMetadata> deleteIndexOperationSettings()
      Returns the object with the settings used for calls to deleteIndex.

    • getIndexSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()
      Returns the object with the settings used for calls to getIndex.

    • listIndexesSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,DatastoreAdminClient.ListIndexesPagedResponse> listIndexesSettings()
      Returns the object with the settings used for calls to listIndexes.

    • create

      public static final DatastoreAdminSettings create(DatastoreAdminStubSettings 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

      public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

    • newBuilder

      public static DatastoreAdminSettings.Builder newBuilder()
      Returns a new gRPC builder for this class.

    • newHttpJsonBuilder

      public static DatastoreAdminSettings.Builder newHttpJsonBuilder()
      Returns a new REST builder for this class.

    • newBuilder

      public static DatastoreAdminSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.

    • toBuilder

      public DatastoreAdminSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      Specified by:
      toBuilder in class com.google.api.gax.rpc.ClientSettings<DatastoreAdminSettings>