Package com.google.cloud.bigtable.admin.v2

Class BigtableInstanceAdminSettings

java.lang.Object

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

public final class BigtableInstanceAdminSettings
extends Object

Settings class to configure an instance of BigtableInstanceAdminClient.

It must be configured with a project ID and can be used to change default RPC settings.

Example usage:

 BigtableInstanceAdminSettings.Builder settingsBuilder = BigtableInstanceAdminSettings.newBuilder()
  .setProjectId("my-project");

 settingsBuilder.stubSettings().createInstanceSettings()
   .setRetrySettings(
     RetrySettings.newBuilder()
       .setTotalTimeout(Duration.ofMinutes(15))
       .build());

 BigtableInstanceAdminSettings settings = settingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
com.google.api.gax.core.CredentialsProvider	getCredentialsProvider()	Gets the credentials provider to use for getting the credentials to make calls with.
String	getProjectId()	Gets the ID of the project whose instances the client will manage.
BigtableInstanceAdminStubSettings	getStubSettings()	Gets the underlying RPC settings.
static BigtableInstanceAdminSettings.Builder	newBuilder()	Returns a new builder for this class.
static BigtableInstanceAdminSettings.Builder	newBuilderForEmulator(int port)	Create a new builder preconfigured to connect to the Bigtable emulator with port number.
static BigtableInstanceAdminSettings.Builder	newBuilderForEmulator(String hostname, int port)	Creates a new builder preconfigured to connect to the Bigtable emulator with host name and port number.
BigtableInstanceAdminSettings.Builder	toBuilder()	Returns a builder containing all the values of this settings class.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getProjectId

@Nonnull
public String getProjectId()

Gets the ID of the project whose instances the client will manage.

getCredentialsProvider

public com.google.api.gax.core.CredentialsProvider getCredentialsProvider()

Gets the credentials provider to use for getting the credentials to make calls with.

getStubSettings

@Nonnull
public BigtableInstanceAdminStubSettings getStubSettings()

Gets the underlying RPC settings.

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public BigtableInstanceAdminSettings.Builder toBuilder()

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

newBuilder

public static BigtableInstanceAdminSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilderForEmulator

public static BigtableInstanceAdminSettings.Builder newBuilderForEmulator(int port)

Create a new builder preconfigured to connect to the Bigtable emulator with port number.

newBuilderForEmulator

public static BigtableInstanceAdminSettings.Builder newBuilderForEmulator(String hostname,
                                                                          int port)

Creates a new builder preconfigured to connect to the Bigtable emulator with host name and port number.