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(value="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 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
 DatastoreAdminSettings.Builder datastoreAdminSettingsBuilder =
     DatastoreAdminSettings.newBuilder();
 datastoreAdminSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         datastoreAdminSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatastoreAdminSettings datastoreAdminSettings = datastoreAdminSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DatastoreAdminSettings	create(DatastoreAdminStubSettings 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.OperationCallSettings<DeleteIndexRequest,Index,IndexOperationMetadata>	deleteIndexOperationSettings() Returns the object with the settings used for calls to deleteIndex.
com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexRequest,com.google.longrunning.Operation>	deleteIndexSettings() Returns the object with the settings used for calls to deleteIndex.
com.google.api.gax.rpc.OperationCallSettings<ExportEntitiesRequest,ExportEntitiesResponse,ExportEntitiesMetadata>	exportEntitiesOperationSettings() Returns the object with the settings used for calls to exportEntities.
com.google.api.gax.rpc.UnaryCallSettings<ExportEntitiesRequest,com.google.longrunning.Operation>	exportEntitiesSettings() Returns the object with the settings used for calls to exportEntities.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
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<ImportEntitiesRequest,com.google.protobuf.Empty,ImportEntitiesMetadata>	importEntitiesOperationSettings() Returns the object with the settings used for calls to importEntities.
com.google.api.gax.rpc.UnaryCallSettings<ImportEntitiesRequest,com.google.longrunning.Operation>	importEntitiesSettings() Returns the object with the settings used for calls to importEntities.
com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,DatastoreAdminClient.ListIndexesPagedResponse>	listIndexesSettings() Returns the object with the settings used for calls to listIndexes.
static DatastoreAdminSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static DatastoreAdminSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static DatastoreAdminSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
DatastoreAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

DatastoreAdminSettings

protected DatastoreAdminSettings(DatastoreAdminSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

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

@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 DatastoreAdminSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
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>