com.google.cloud.bigtable.v2

Class BigtableSettings

java.lang.Object

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

com.google.cloud.bigtable.v2.BigtableSettings

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

Settings class to configure an instance of BigtableClient.

The default instance has everything set to sensible defaults:

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

 
 BigtableSettings.Builder bigtableSettingsBuilder =
     BigtableSettings.newBuilder();
 bigtableSettingsBuilder.mutateRowSettings().getRetrySettingsBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 BigtableSettings bigtableSettings = bigtableSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.v2.CheckAndMutateRowRequest,com.google.bigtable.v2.CheckAndMutateRowResponse>	checkAndMutateRowSettings() Returns the object with the settings used for calls to checkAndMutateRow.
BigtableStub	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()
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.v2.MutateRowRequest,com.google.bigtable.v2.MutateRowResponse>	mutateRowSettings() Returns the object with the settings used for calls to mutateRow.
com.google.api.gax.rpc.StreamingCallSettings<com.google.bigtable.v2.MutateRowsRequest,com.google.bigtable.v2.MutateRowsResponse>	mutateRowsSettings() Returns the object with the settings used for calls to mutateRows.
static BigtableSettings.Builder	newBuilder() Returns a new builder for this class.
static BigtableSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.v2.ReadModifyWriteRowRequest,com.google.bigtable.v2.ReadModifyWriteRowResponse>	readModifyWriteRowSettings() Returns the object with the settings used for calls to readModifyWriteRow.
com.google.api.gax.rpc.StreamingCallSettings<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse>	readRowsSettings() Returns the object with the settings used for calls to readRows.
com.google.api.gax.rpc.StreamingCallSettings<com.google.bigtable.v2.SampleRowKeysRequest,com.google.bigtable.v2.SampleRowKeysResponse>	sampleRowKeysSettings() Returns the object with the settings used for calls to sampleRowKeys.
BigtableSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

readRowsSettings

public com.google.api.gax.rpc.StreamingCallSettings<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse> readRowsSettings()

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

sampleRowKeysSettings

public com.google.api.gax.rpc.StreamingCallSettings<com.google.bigtable.v2.SampleRowKeysRequest,com.google.bigtable.v2.SampleRowKeysResponse> sampleRowKeysSettings()

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

mutateRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.v2.MutateRowRequest,com.google.bigtable.v2.MutateRowResponse> mutateRowSettings()

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

mutateRowsSettings

public com.google.api.gax.rpc.StreamingCallSettings<com.google.bigtable.v2.MutateRowsRequest,com.google.bigtable.v2.MutateRowsResponse> mutateRowsSettings()

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

checkAndMutateRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.v2.CheckAndMutateRowRequest,com.google.bigtable.v2.CheckAndMutateRowResponse> checkAndMutateRowSettings()

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

readModifyWriteRowSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.bigtable.v2.ReadModifyWriteRowRequest,com.google.bigtable.v2.ReadModifyWriteRowResponse> readModifyWriteRowSettings()

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

createStub

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

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public BigtableSettings.Builder toBuilder()

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

Specified by:

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