com.google.cloud.bigtable.grpc

Class BigtableClusterName

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableClusterName

@InternalExtensionOnly
public class BigtableClusterName
extends Object

This class encapsulates a cluster name of the form projects/(projectId)/instances/(instanceId)/clusters/(clusterId)

Constructor Summary

Constructors

Constructor and Description
BigtableClusterName(String clusterName) For internal use only - public for technical reasons.

Method Summary

Modifier and Type	Method and Description
String	getClusterId()
String	getClusterName()
String	getInstanceId()
String	toBackupName(String backupId) Create a fully qualified backup name based on the the clusterName and the backupId.
String	toSnapshotName(String snapshotId) Deprecated. this will be removed in a future release - please use backups API instead
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableClusterName

@InternalApi(value="For internal usage only")
public BigtableClusterName(String clusterName)

For internal use only - public for technical reasons.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

Returns:

the fully qualified cluster name. This method returns the same result as getClusterName().

getInstanceId

public String getInstanceId()

Returns:

The id of the instance that contains this cluster. It's the second group in the Cluster name: "projects/{projectId}/instances/{instanceId}/clusters/{clusterId}".

getClusterName

public String getClusterName()

Returns:

The name of this cluster. It will look like the following "projects/{projectId}/instances/{instanceId}/clusters/{clusterId}".

getClusterId

public String getClusterId()

Returns:

The id of this cluster. It's the third group in the Cluster name: "projects/{projectId}/instances/{instanceId}/clusters/{clusterId}".

toSnapshotName

@Deprecated
public String toSnapshotName(String snapshotId)

Deprecated. this will be removed in a future release - please use backups API instead

Create a fully qualified snapshot name based on the the clusterName and the snapshotId. Snapshot name will look like: "projects/{projectId}/instances/{instanceId}/clusters/{clusterId}/snapshots/{snapshotId}".

Parameters:

snapshotId - The id of the snapshot

Returns:

A fully qualified snapshot name that contains the fully qualified cluster name as the parent and the snapshot name as the child.

toBackupName

public String toBackupName(String backupId)

Create a fully qualified backup name based on the the clusterName and the backupId. Backup name will look like: "projects/{projectId}/instances/{instanceId}/clusters/{clusterId}/backups/{backupId}".

Parameters:

backupId - The id of the backup

Returns:

A fully qualified backup name that contains the fully qualified cluster name as the parent and the backup name as the child.