com.google.cloud.bigtable.admin.v2

Class BigtableInstanceAdminSettings

java.lang.Object

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

com.google.cloud.bigtable.admin.v2.BigtableInstanceAdminSettings

@Generated(value="by GAPIC v0.0.5")
 @BetaApi
public class BigtableInstanceAdminSettings
extends com.google.api.gax.rpc.ClientSettings<BigtableInstanceAdminSettings>

Settings class to configure an instance of BigtableInstanceAdminClient.

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:

 
 BigtableInstanceAdminSettings.Builder bigtableInstanceAdminSettingsBuilder =
     BigtableInstanceAdminSettings.newBuilder();
 bigtableInstanceAdminSettingsBuilder.getInstanceSettings().getRetrySettingsBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 BigtableInstanceAdminSettings bigtableInstanceAdminSettings = bigtableInstanceAdminSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,com.google.longrunning.Operation>	createClusterSettings() Returns the object with the settings used for calls to createCluster.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,com.google.longrunning.Operation>	createInstanceSettings() Returns the object with the settings used for calls to createInstance.
BigtableInstanceAdminStub	createStub()
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 ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.DeleteClusterRequest,com.google.protobuf.Empty>	deleteClusterSettings() Returns the object with the settings used for calls to deleteCluster.
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.DeleteInstanceRequest,com.google.protobuf.Empty>	deleteInstanceSettings() Returns the object with the settings used for calls to deleteInstance.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.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 BigtableInstanceAdminSettings.Builder	newBuilder() Returns a new builder for this class.
static BigtableInstanceAdminSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
BigtableInstanceAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.Cluster,com.google.longrunning.Operation>	updateClusterSettings() Returns the object with the settings used for calls to updateCluster.
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.Instance>	updateInstanceSettings() Returns the object with the settings used for calls to updateInstance.

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

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Method Detail

createInstanceSettings

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

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

createInstanceOperationSettings

public com.google.api.gax.rpc.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 com.google.api.gax.rpc.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 com.google.api.gax.rpc.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.

updateInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.Instance> updateInstanceSettings()

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

deleteInstanceSettings

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

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

createClusterSettings

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

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

createClusterOperationSettings

public com.google.api.gax.rpc.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 com.google.api.gax.rpc.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 com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.Cluster,com.google.longrunning.Operation> updateClusterSettings()

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

updateClusterOperationSettings

public com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.admin.v2.DeleteClusterRequest,com.google.protobuf.Empty> deleteClusterSettings()

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

createStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public BigtableInstanceAdminStub createStub()
                                                                                                                                   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 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 BigtableInstanceAdminSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static BigtableInstanceAdminSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public BigtableInstanceAdminSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<BigtableInstanceAdminSettings>