com.google.cloud.bigtable.grpc
Class BigtableInstanceGrpcClient
- java.lang.Object
-
- com.google.cloud.bigtable.grpc.BigtableInstanceGrpcClient
-
- All Implemented Interfaces:
- BigtableInstanceClient
public class BigtableInstanceGrpcClient extends Object implements BigtableInstanceClient
BigtableInstanceGrpcClient class.- Version:
- $Id: $Id
- Author:
- sduskis
-
-
Constructor Summary
Constructors Constructor and Description BigtableInstanceGrpcClient(io.grpc.Channel channel)
Constructor for BigtableInstanceGrpcClient.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description com.google.bigtable.admin.v2.AppProfile
createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest request)
Create an application profile.com.google.longrunning.Operation
createCluster(com.google.bigtable.admin.v2.CreateClusterRequest request)
Create an instance within a project.com.google.longrunning.Operation
createInstance(com.google.bigtable.admin.v2.CreateInstanceRequest request)
Create an instance within a project.Empty
deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)
Delete an application profile.Empty
deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest request)
Deletes a cluster from an instance.Empty
deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request)
Updates an instance within a project.com.google.bigtable.admin.v2.AppProfile
getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest request)
Get an application profile.com.google.bigtable.admin.v2.Cluster
getCluster(com.google.bigtable.admin.v2.GetClusterRequest request)
Gets information about a cluster.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Get an IAM policy.com.google.longrunning.Operation
getOperation(com.google.longrunning.GetOperationRequest request)
Gets the latest state of a long-running operation.com.google.bigtable.admin.v2.ListAppProfilesResponse
listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest request)
List application profiles.com.google.bigtable.admin.v2.ListClustersResponse
listCluster(com.google.bigtable.admin.v2.ListClustersRequest request)
Lists information about clusters in an instance.com.google.bigtable.admin.v2.ListInstancesResponse
listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request)
Lists all instances in the given project.com.google.longrunning.Operation
partialUpdateInstance(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest request)
Partially updates an instance within a project.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Set an IAM policy.com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Tests an IAM policy.com.google.longrunning.Operation
updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)
/** Update an application profile.com.google.longrunning.Operation
updateCluster(com.google.bigtable.admin.v2.Cluster cluster)
Updates a cluster within an instance.com.google.bigtable.admin.v2.Instance
updateInstance(com.google.bigtable.admin.v2.Instance instance)
Updates an instance within a project.void
waitForOperation(com.google.longrunning.Operation operation)
Waits for the long running operation to complete by polling with exponential backoff.void
waitForOperation(com.google.longrunning.Operation operation, long timeout, TimeUnit timeUnit)
Waits for the long running operation to complete by polling with exponential backoff.
-
-
-
Constructor Detail
-
BigtableInstanceGrpcClient
public BigtableInstanceGrpcClient(io.grpc.Channel channel)
Constructor for BigtableInstanceGrpcClient.- Parameters:
channel
- aChannel
object.
-
-
Method Detail
-
createInstance
public com.google.longrunning.Operation createInstance(com.google.bigtable.admin.v2.CreateInstanceRequest request)
Create an instance within a project.- Specified by:
createInstance
in interfaceBigtableInstanceClient
- Parameters:
request
- aCreateInstanceRequest
object.- Returns:
- a
Operation
object.
-
getOperation
public com.google.longrunning.Operation getOperation(com.google.longrunning.GetOperationRequest request)
Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.BigtableInstanceClient.createInstance(CreateInstanceRequest)
andBigtableInstanceClient.updateCluster(Cluster)
will return aOperation
. Use this method and pass in theOperation
's name in the request to see if the Operation is done viaOperation.getDone()
. The instance will not be available until that happens.- Specified by:
getOperation
in interfaceBigtableInstanceClient
- Parameters:
request
- aGetOperationRequest
object.- Returns:
- a
Operation
object.
-
waitForOperation
public void waitForOperation(com.google.longrunning.Operation operation) throws IOException, TimeoutException
Waits for the long running operation to complete by polling with exponential backoff. A default timeout of 10 minutes is used.- Specified by:
waitForOperation
in interfaceBigtableInstanceClient
- Throws:
IOException
TimeoutException
- If the timeout is exceeded.
-
waitForOperation
public void waitForOperation(com.google.longrunning.Operation operation, long timeout, TimeUnit timeUnit) throws TimeoutException, IOException
Waits for the long running operation to complete by polling with exponential backoff.- Specified by:
waitForOperation
in interfaceBigtableInstanceClient
- Throws:
TimeoutException
- If the timeout is exceeded.IOException
-
listInstances
public com.google.bigtable.admin.v2.ListInstancesResponse listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request)
Lists all instances in the given project.- Specified by:
listInstances
in interfaceBigtableInstanceClient
- Parameters:
request
- aListInstancesRequest
object.- Returns:
- a
ListInstancesResponse
object.
-
updateInstance
public com.google.bigtable.admin.v2.Instance updateInstance(com.google.bigtable.admin.v2.Instance instance)
Updates an instance within a project.- Specified by:
updateInstance
in interfaceBigtableInstanceClient
- Parameters:
instance
- aInstance
object.- Returns:
- a
Instance
object.
-
deleteInstance
public Empty deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request)
Updates an instance within a project.- Specified by:
deleteInstance
in interfaceBigtableInstanceClient
- Parameters:
request
- aDeleteInstanceRequest
object.- Returns:
- a
Empty
object.
-
getCluster
public com.google.bigtable.admin.v2.Cluster getCluster(com.google.bigtable.admin.v2.GetClusterRequest request)
Gets information about a cluster.- Specified by:
getCluster
in interfaceBigtableInstanceClient
- Parameters:
request
- aGetClusterRequest
object.- Returns:
- a
Cluster
object.
-
listCluster
public com.google.bigtable.admin.v2.ListClustersResponse listCluster(com.google.bigtable.admin.v2.ListClustersRequest request)
Lists information about clusters in an instance.- Specified by:
listCluster
in interfaceBigtableInstanceClient
- Parameters:
request
- aListClustersRequest
object.- Returns:
- a
ListClustersResponse
object.
-
updateCluster
public com.google.longrunning.Operation updateCluster(com.google.bigtable.admin.v2.Cluster cluster)
Updates a cluster within an instance.- Specified by:
updateCluster
in interfaceBigtableInstanceClient
- Parameters:
cluster
- aCluster
object.- Returns:
- a
Operation
object.
-
deleteCluster
public Empty deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest request)
Deletes a cluster from an instance.- Specified by:
deleteCluster
in interfaceBigtableInstanceClient
- Parameters:
request
- aDeleteClusterRequest
object.- Returns:
- a
Empty
object.
-
partialUpdateInstance
public com.google.longrunning.Operation partialUpdateInstance(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest request)
Partially updates an instance within a project.- Specified by:
partialUpdateInstance
in interfaceBigtableInstanceClient
- Parameters:
request
- aPartialUpdateInstanceRequest
object.- Returns:
- a
Operation
object.
-
createAppProfile
public com.google.bigtable.admin.v2.AppProfile createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest request)
Create an application profile.- Specified by:
createAppProfile
in interfaceBigtableInstanceClient
- Parameters:
request
- aCreateAppProfileRequest
object.- Returns:
- a
AppProfile
object. - See Also:
- App Profiles
-
getAppProfile
public com.google.bigtable.admin.v2.AppProfile getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest request)
Get an application profile.- Specified by:
getAppProfile
in interfaceBigtableInstanceClient
- Parameters:
request
- aGetAppProfileRequest
object.- Returns:
- a
AppProfile
object. - See Also:
- App Profiles
-
listAppProfiles
public com.google.bigtable.admin.v2.ListAppProfilesResponse listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest request)
List application profiles.- Specified by:
listAppProfiles
in interfaceBigtableInstanceClient
- Parameters:
request
- aListAppProfilesRequest
object.- Returns:
- a
ListAppProfilesResponse
object. - See Also:
- App Profiles
-
updateAppProfile
public com.google.longrunning.Operation updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)
/** Update an application profile.- Specified by:
updateAppProfile
in interfaceBigtableInstanceClient
- Parameters:
request
- aUpdateAppProfileRequest
object.- Returns:
- a
Operation
object. - See Also:
- App Profiles
-
deleteAppProfile
public Empty deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)
Delete an application profile.- Specified by:
deleteAppProfile
in interfaceBigtableInstanceClient
- Parameters:
request
- aDeleteAppProfileRequest
object.- Returns:
- a
Empty
object. - See Also:
- App Profiles
-
getIamPolicy
public com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Get an IAM policy.- Specified by:
getIamPolicy
in interfaceBigtableInstanceClient
- Parameters:
request
- aGetIamPolicyRequest
object.- Returns:
- a
Policy
object. - See Also:
- Cloud Bigtable access control
-
setIamPolicy
public com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Set an IAM policy.- Specified by:
setIamPolicy
in interfaceBigtableInstanceClient
- Parameters:
request
- aSetIamPolicyRequest
object.- Returns:
- a
Policy
object. - See Also:
- Cloud Bigtable access control
-
testIamPermissions
public com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Tests an IAM policy.- Specified by:
testIamPermissions
in interfaceBigtableInstanceClient
- Parameters:
request
- aTestIamPermissionsRequest
object.- Returns:
- a
TestIamPermissionsResponse
object. - See Also:
- Cloud Bigtable access control
-
createCluster
public com.google.longrunning.Operation createCluster(com.google.bigtable.admin.v2.CreateClusterRequest request)
Create an instance within a project.- Specified by:
createCluster
in interfaceBigtableInstanceClient
- Parameters:
request
- aCreateClusterRequest
object.- Returns:
- a
Operation
object.
-
-