com.google.cloud.bigtable.admin.v2

Class BaseBigtableInstanceAdminSettings

java.lang.Object

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

com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminSettings

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

Settings class to configure an instance of BaseBigtableInstanceAdminClient.

The default instance has everything set to sensible defaults:

• The default service address (bigtableadmin.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 getInstance to 30 seconds:

 
 BaseBigtableInstanceAdminSettings.Builder baseBigtableInstanceAdminSettingsBuilder =
     BaseBigtableInstanceAdminSettings.newBuilder();
 baseBigtableInstanceAdminSettingsBuilder.getInstanceSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 BaseBigtableInstanceAdminSettings baseBigtableInstanceAdminSettings = baseBigtableInstanceAdminSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BaseBigtableInstanceAdminSettings	create(BigtableInstanceAdminStubSettings stub)
UnaryCallSettings<com.google.bigtable.admin.v2.CreateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>	createAppProfileSettings() Returns the object with the settings used for calls to createAppProfile.
OperationCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>	createClusterOperationSettings() Returns the object with the settings used for calls to createCluster.
UnaryCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,Operation>	createClusterSettings() Returns the object with the settings used for calls to createCluster.
OperationCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>	createInstanceOperationSettings() Returns the object with the settings used for calls to createInstance.
UnaryCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,Operation>	createInstanceSettings() Returns the object with the settings used for calls to createInstance.
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.bigtable.admin.v2.DeleteAppProfileRequest,Empty>	deleteAppProfileSettings() Returns the object with the settings used for calls to deleteAppProfile.
UnaryCallSettings<com.google.bigtable.admin.v2.DeleteClusterRequest,Empty>	deleteClusterSettings() Returns the object with the settings used for calls to deleteCluster.
UnaryCallSettings<com.google.bigtable.admin.v2.DeleteInstanceRequest,Empty>	deleteInstanceSettings() Returns the object with the settings used for calls to deleteInstance.
UnaryCallSettings<com.google.bigtable.admin.v2.GetAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>	getAppProfileSettings() Returns the object with the settings used for calls to getAppProfile.
UnaryCallSettings<com.google.bigtable.admin.v2.GetClusterRequest,com.google.bigtable.admin.v2.Cluster>	getClusterSettings() Returns the object with the settings used for calls to getCluster.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<com.google.bigtable.admin.v2.GetInstanceRequest,com.google.bigtable.admin.v2.Instance>	getInstanceSettings() Returns the object with the settings used for calls to getInstance.
PagedCallSettings<com.google.bigtable.admin.v2.ListAppProfilesRequest,com.google.bigtable.admin.v2.ListAppProfilesResponse,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse>	listAppProfilesSettings() Returns the object with the settings used for calls to listAppProfiles.
UnaryCallSettings<com.google.bigtable.admin.v2.ListClustersRequest,com.google.bigtable.admin.v2.ListClustersResponse>	listClustersSettings() Returns the object with the settings used for calls to listClusters.
UnaryCallSettings<com.google.bigtable.admin.v2.ListInstancesRequest,com.google.bigtable.admin.v2.ListInstancesResponse>	listInstancesSettings() Returns the object with the settings used for calls to listInstances.
static BaseBigtableInstanceAdminSettings.Builder	newBuilder() Returns a new builder for this class.
static BaseBigtableInstanceAdminSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
OperationCallSettings<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>	partialUpdateInstanceOperationSettings() Returns the object with the settings used for calls to partialUpdateInstance.
UnaryCallSettings<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,Operation>	partialUpdateInstanceSettings() Returns the object with the settings used for calls to partialUpdateInstance.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
BaseBigtableInstanceAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
OperationCallSettings<com.google.bigtable.admin.v2.UpdateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>	updateAppProfileOperationSettings() Returns the object with the settings used for calls to updateAppProfile.
UnaryCallSettings<com.google.bigtable.admin.v2.UpdateAppProfileRequest,Operation>	updateAppProfileSettings() Returns the object with the settings used for calls to updateAppProfile.
OperationCallSettings<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata>	updateClusterOperationSettings() Returns the object with the settings used for calls to updateCluster.
UnaryCallSettings<com.google.bigtable.admin.v2.Cluster,Operation>	updateClusterSettings() Returns the object with the settings used for calls to updateCluster.

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

BaseBigtableInstanceAdminSettings

protected BaseBigtableInstanceAdminSettings(BaseBigtableInstanceAdminSettings.Builder settingsBuilder)
                                     throws IOException

Throws:

IOException

Method Detail

createInstanceSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,Operation> createInstanceSettings()

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

createInstanceOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata> createInstanceOperationSettings()

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

getInstanceSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.GetInstanceRequest,com.google.bigtable.admin.v2.Instance> getInstanceSettings()

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

listInstancesSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.ListInstancesRequest,com.google.bigtable.admin.v2.ListInstancesResponse> listInstancesSettings()

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

partialUpdateInstanceSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,Operation> partialUpdateInstanceSettings()

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

partialUpdateInstanceOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata> partialUpdateInstanceOperationSettings()

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

deleteInstanceSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.DeleteInstanceRequest,Empty> deleteInstanceSettings()

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

createClusterSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,Operation> createClusterSettings()

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

createClusterOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata> createClusterOperationSettings()

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

getClusterSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.GetClusterRequest,com.google.bigtable.admin.v2.Cluster> getClusterSettings()

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

listClustersSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.ListClustersRequest,com.google.bigtable.admin.v2.ListClustersResponse> listClustersSettings()

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

updateClusterSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.Cluster,Operation> updateClusterSettings()

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

updateClusterOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata> updateClusterOperationSettings()

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

deleteClusterSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.DeleteClusterRequest,Empty> deleteClusterSettings()

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

createAppProfileSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.CreateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile> createAppProfileSettings()

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

getAppProfileSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.GetAppProfileRequest,com.google.bigtable.admin.v2.AppProfile> getAppProfileSettings()

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

listAppProfilesSettings

public PagedCallSettings<com.google.bigtable.admin.v2.ListAppProfilesRequest,com.google.bigtable.admin.v2.ListAppProfilesResponse,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse> listAppProfilesSettings()

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

updateAppProfileSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.UpdateAppProfileRequest,Operation> updateAppProfileSettings()

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

updateAppProfileOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.bigtable.admin.v2.UpdateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata> updateAppProfileOperationSettings()

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

deleteAppProfileSettings

public UnaryCallSettings<com.google.bigtable.admin.v2.DeleteAppProfileRequest,Empty> deleteAppProfileSettings()

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

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final BaseBigtableInstanceAdminSettings create(BigtableInstanceAdminStubSettings 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 BaseBigtableInstanceAdminSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static BaseBigtableInstanceAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public BaseBigtableInstanceAdminSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<BaseBigtableInstanceAdminSettings>