Package com.google.cloud.bigtable.grpc

Class BigtableInstanceName

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableInstanceName

All Implemented Interfaces:

Serializable

public class BigtableInstanceName
extends Object
implements Serializable

This class encapsulates a Bigtable instance name. An instance name is of the form projects/(projectId)/instances/(instanceId). It also has convenience methods to create a tableName and a tableId. TableName is (instanceName)/tables/(tableId).

Version:

$Id: $Id

Author:

sduskis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BIGTABLE_V2_INSTANCE_FMT	Constant BIGTABLE_V2_INSTANCE_FMT="projects/%s/instances/%s"
static String	TABLE_SEPARATOR	Constant TABLE_SEPARATOR="/tables/"

Constructor Summary

Constructors

Constructor	Description
BigtableInstanceName(String projectId, String instanceId)	Constructor for BigtableInstanceName.

Method Summary

Modifier and Type	Method	Description
String	getInstanceId()
String	getInstanceName()
String	getProjectId()
com.google.bigtable.admin.v2.InstanceName	toAdminInstanceName()
BigtableClusterName	toClusterName(String clusterId)
com.google.cloud.bigtable.data.v2.models.InstanceName	toGcbInstanceName()
String	toString()	Get the instance name.
String	toTableId(String tableName)	Transforms a tableName within this instance of the form projects/(projectId)/instances/(instanceId)/tables/(tableId) to (tableId).
BigtableTableName	toTableName(String tableId)	toTableName.
String	toTableNameStr(String tableId)	toTableNameStr.

Methods inherited from class java.lang.Object

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

Field Detail

BIGTABLE_V2_INSTANCE_FMT

public static final String BIGTABLE_V2_INSTANCE_FMT

Constant BIGTABLE_V2_INSTANCE_FMT="projects/%s/instances/%s"

See Also:

Constant Field Values

TABLE_SEPARATOR

public static final String TABLE_SEPARATOR

Constant TABLE_SEPARATOR="/tables/"

See Also:

Constant Field Values

Constructor Detail

BigtableInstanceName

public BigtableInstanceName(String projectId,
                            String instanceId)

Constructor for BigtableInstanceName.

Parameters:

projectId - a String object.

instanceId - a String object.

Method Detail

toString

public String toString()

Get the instance name.

Overrides:

toString in class Object

toTableId

public String toTableId(String tableName)

Transforms a tableName within this instance of the form projects/(projectId)/instances/(instanceId)/tables/(tableId) to (tableId).

Parameters:

tableName - a String object.

Returns:

a String object.

toTableNameStr

public String toTableNameStr(String tableId)

toTableNameStr.

Parameters:

tableId - a String object.

Returns:

a String object.

toTableName

public BigtableTableName toTableName(String tableId)

toTableName.

Parameters:

tableId - a String object.

Returns:

a BigtableTableName object.

getProjectId

public String getProjectId()

Returns:

the projectId

getInstanceId

public String getInstanceId()

Returns:

the instanceId

getInstanceName

public String getInstanceName()

Returns:

the fully qualified instanceName with the form 'projects/{projectId}/instances/{instanceId}'.

toGcbInstanceName

public com.google.cloud.bigtable.data.v2.models.InstanceName toGcbInstanceName()

toAdminInstanceName

public com.google.bigtable.admin.v2.InstanceName toAdminInstanceName()

toClusterName

public BigtableClusterName toClusterName(String clusterId)