Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.
Client for the BigtableInstanceAdmin service.
Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the BigtableInstanceAdmin Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all BigtableInstanceAdmin clients ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the BigtableInstanceAdmin Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_app_profile
def create_app_profile(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
def create_app_profile(parent: nil, app_profile_id: nil, app_profile: nil, ignore_warnings: nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
Creates an app profile within an instance.
def create_app_profile(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
create_app_profile
via a request object, either of type
CreateAppProfileRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::CreateAppProfileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_app_profile(parent: nil, app_profile_id: nil, app_profile: nil, ignore_warnings: nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
create_app_profile
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The unique name of the instance in which to create the new app
profile. Values are of the form
projects/{project}/instances/{instance}
. -
app_profile_id (::String) — Required. The ID to be used when referring to the new app profile within
its instance, e.g., just
myprofile
rather thanprojects/myproject/instances/myinstance/appProfiles/myprofile
. -
app_profile (::Google::Cloud::Bigtable::Admin::V2::AppProfile, ::Hash) — Required. The app profile to be created.
Fields marked
OutputOnly
will be ignored. - ignore_warnings (::Boolean) — If true, ignore safety checks when creating the app profile.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::AppProfile)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::CreateAppProfileRequest.new # Call the create_app_profile method. result = client.create_app_profile request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::AppProfile. p result
#create_cluster
def create_cluster(request, options = nil) -> ::Gapic::Operation
def create_cluster(parent: nil, cluster_id: nil, cluster: nil) -> ::Gapic::Operation
Creates a cluster within an instance.
Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
def create_cluster(request, options = nil) -> ::Gapic::Operation
create_cluster
via a request object, either of type
CreateClusterRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::CreateClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_cluster(parent: nil, cluster_id: nil, cluster: nil) -> ::Gapic::Operation
create_cluster
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The unique name of the instance in which to create the new
cluster. Values are of the form
projects/{project}/instances/{instance}
. -
cluster_id (::String) — Required. The ID to be used when referring to the new cluster within its
instance, e.g., just
mycluster
rather thanprojects/myproject/instances/myinstance/clusters/mycluster
. -
cluster (::Google::Cloud::Bigtable::Admin::V2::Cluster, ::Hash) — Required. The cluster to be created.
Fields marked
OutputOnly
must be left blank.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::CreateClusterRequest.new # Call the create_cluster method. result = client.create_cluster request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#create_instance
def create_instance(request, options = nil) -> ::Gapic::Operation
def create_instance(parent: nil, instance_id: nil, instance: nil, clusters: nil) -> ::Gapic::Operation
Create an instance within a project.
Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.
def create_instance(request, options = nil) -> ::Gapic::Operation
create_instance
via a request object, either of type
CreateInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::CreateInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_instance(parent: nil, instance_id: nil, instance: nil, clusters: nil) -> ::Gapic::Operation
create_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The unique name of the project in which to create the new
instance. Values are of the form
projects/{project}
. -
instance_id (::String) — Required. The ID to be used when referring to the new instance within its
project, e.g., just
myinstance
rather thanprojects/myproject/instances/myinstance
. -
instance (::Google::Cloud::Bigtable::Admin::V2::Instance, ::Hash) — Required. The instance to create.
Fields marked
OutputOnly
must be left blank. -
clusters (::Hash{::String => ::Google::Cloud::Bigtable::Admin::V2::Cluster, ::Hash}) — Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just
mycluster
rather thanprojects/myproject/instances/myinstance/clusters/mycluster
. Fields markedOutputOnly
must be left blank. Currently, at most four clusters can be specified.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::CreateInstanceRequest.new # Call the create_instance method. result = client.create_instance request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_app_profile
def delete_app_profile(request, options = nil) -> ::Google::Protobuf::Empty
def delete_app_profile(name: nil, ignore_warnings: nil) -> ::Google::Protobuf::Empty
Deletes an app profile from an instance.
def delete_app_profile(request, options = nil) -> ::Google::Protobuf::Empty
delete_app_profile
via a request object, either of type
DeleteAppProfileRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::DeleteAppProfileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_app_profile(name: nil, ignore_warnings: nil) -> ::Google::Protobuf::Empty
delete_app_profile
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The unique name of the app profile to be deleted. Values are of
the form
projects/{project}/instances/{instance}/appProfiles/{app_profile}
. - ignore_warnings (::Boolean) — Required. If true, ignore safety checks when deleting the app profile.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::DeleteAppProfileRequest.new # Call the delete_app_profile method. result = client.delete_app_profile request # The returned object is of type Google::Protobuf::Empty. p result
#delete_cluster
def delete_cluster(request, options = nil) -> ::Google::Protobuf::Empty
def delete_cluster(name: nil) -> ::Google::Protobuf::Empty
Deletes a cluster from an instance.
def delete_cluster(request, options = nil) -> ::Google::Protobuf::Empty
delete_cluster
via a request object, either of type
DeleteClusterRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::DeleteClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_cluster(name: nil) -> ::Google::Protobuf::Empty
delete_cluster
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The unique name of the cluster to be deleted. Values are of the
form
projects/{project}/instances/{instance}/clusters/{cluster}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::DeleteClusterRequest.new # Call the delete_cluster method. result = client.delete_cluster request # The returned object is of type Google::Protobuf::Empty. p result
#delete_instance
def delete_instance(request, options = nil) -> ::Google::Protobuf::Empty
def delete_instance(name: nil) -> ::Google::Protobuf::Empty
Delete an instance from a project.
def delete_instance(request, options = nil) -> ::Google::Protobuf::Empty
delete_instance
via a request object, either of type
DeleteInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::DeleteInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_instance(name: nil) -> ::Google::Protobuf::Empty
delete_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The unique name of the instance to be deleted.
Values are of the form
projects/{project}/instances/{instance}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::DeleteInstanceRequest.new # Call the delete_instance method. result = client.delete_instance request # The returned object is of type Google::Protobuf::Empty. p result
#get_app_profile
def get_app_profile(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
def get_app_profile(name: nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
Gets information about an app profile.
def get_app_profile(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
get_app_profile
via a request object, either of type
GetAppProfileRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::GetAppProfileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_app_profile(name: nil) -> ::Google::Cloud::Bigtable::Admin::V2::AppProfile
get_app_profile
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The unique name of the requested app profile. Values are of the
form
projects/{project}/instances/{instance}/appProfiles/{app_profile}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::AppProfile)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::GetAppProfileRequest.new # Call the get_app_profile method. result = client.get_app_profile request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::AppProfile. p result
#get_cluster
def get_cluster(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster
def get_cluster(name: nil) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster
Gets information about a cluster.
def get_cluster(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster
get_cluster
via a request object, either of type
GetClusterRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::GetClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_cluster(name: nil) -> ::Google::Cloud::Bigtable::Admin::V2::Cluster
get_cluster
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The unique name of the requested cluster. Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::Cluster)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::GetClusterRequest.new # Call the get_cluster method. result = client.get_cluster request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Cluster. p result
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via a request object, either of type
Iam::V1::GetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
-
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::GetIamPolicyRequest.new # Call the get_iam_policy method. result = client.get_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#get_instance
def get_instance(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
def get_instance(name: nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
Gets information about an instance.
def get_instance(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
get_instance
via a request object, either of type
GetInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::GetInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_instance(name: nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
get_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The unique name of the requested instance. Values are of the form
projects/{project}/instances/{instance}
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::Instance)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::GetInstanceRequest.new # Call the get_instance method. result = client.get_instance request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Instance. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new BigtableInstanceAdmin client object.
- (config) — Configure the BigtableInstanceAdmin client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new do |config| config.timeout = 10.0 end
#list_app_profiles
def list_app_profiles(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::AppProfile>
def list_app_profiles(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::AppProfile>
Lists information about app profiles in an instance.
def list_app_profiles(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::AppProfile>
list_app_profiles
via a request object, either of type
ListAppProfilesRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::ListAppProfilesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_app_profiles(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::AppProfile>
list_app_profiles
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The unique name of the instance for which a list of app profiles
is requested. Values are of the form
projects/{project}/instances/{instance}
. Use{instance} = '-'
to list AppProfiles for all Instances in a project, e.g.,projects/myproject/instances/-
. -
page_size (::Integer) — Maximum number of results per page.
A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.
Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
-
page_token (::String) — The value of
next_page_token
returned by a previous call.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::AppProfile>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::AppProfile>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::ListAppProfilesRequest.new # Call the list_app_profiles method. result = client.list_app_profiles request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::AppProfile. p item end
#list_clusters
def list_clusters(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListClustersResponse
def list_clusters(parent: nil, page_token: nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListClustersResponse
Lists information about clusters in an instance.
def list_clusters(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListClustersResponse
list_clusters
via a request object, either of type
ListClustersRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::ListClustersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_clusters(parent: nil, page_token: nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListClustersResponse
list_clusters
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The unique name of the instance for which a list of clusters is
requested. Values are of the form
projects/{project}/instances/{instance}
. Use{instance} = '-'
to list Clusters for all Instances in a project, e.g.,projects/myproject/instances/-
. - page_token (::String) — DEPRECATED: This field is unused and ignored.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::ListClustersResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::ListClustersRequest.new # Call the list_clusters method. result = client.list_clusters request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::ListClustersResponse. p result
#list_hot_tablets
def list_hot_tablets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>
def list_hot_tablets(parent: nil, start_time: nil, end_time: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>
Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
def list_hot_tablets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>
list_hot_tablets
via a request object, either of type
ListHotTabletsRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_hot_tablets(parent: nil, start_time: nil, end_time: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>
list_hot_tablets
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The cluster name to list hot tablets.
Value is in the following form:
projects/{project}/instances/{instance}/clusters/{cluster}
. - start_time (::Google::Protobuf::Timestamp, ::Hash) — The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.
- end_time (::Google::Protobuf::Timestamp, ::Hash) — The end time to list hot tablets.
-
page_size (::Integer) — Maximum number of results per page.
A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.
Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
-
page_token (::String) — The value of
next_page_token
returned by a previous call.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigtable::Admin::V2::HotTablet>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::ListHotTabletsRequest.new # Call the list_hot_tablets method. result = client.list_hot_tablets request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::HotTablet. p item end
#list_instances
def list_instances(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListInstancesResponse
def list_instances(parent: nil, page_token: nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListInstancesResponse
Lists information about instances in a project.
def list_instances(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListInstancesResponse
list_instances
via a request object, either of type
ListInstancesRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::ListInstancesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_instances(parent: nil, page_token: nil) -> ::Google::Cloud::Bigtable::Admin::V2::ListInstancesResponse
list_instances
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::ListInstancesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::ListInstancesRequest.new # Call the list_instances method. result = client.list_instances request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::ListInstancesResponse. p result
#logger
def logger() -> Logger
The logger used for request/response debug logging.
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Operations
Get the associated client for long-running operations.
#partial_update_cluster
def partial_update_cluster(request, options = nil) -> ::Gapic::Operation
def partial_update_cluster(cluster: nil, update_mask: nil) -> ::Gapic::Operation
Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask.
To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.
def partial_update_cluster(request, options = nil) -> ::Gapic::Operation
partial_update_cluster
via a request object, either of type
PartialUpdateClusterRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::PartialUpdateClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def partial_update_cluster(cluster: nil, update_mask: nil) -> ::Gapic::Operation
partial_update_cluster
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- cluster (::Google::Cloud::Bigtable::Admin::V2::Cluster, ::Hash) — Required. The Cluster which contains the partial updates to be applied, subject to the update_mask.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The subset of Cluster fields which should be replaced.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::PartialUpdateClusterRequest.new # Call the partial_update_cluster method. result = client.partial_update_cluster request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#partial_update_instance
def partial_update_instance(request, options = nil) -> ::Gapic::Operation
def partial_update_instance(instance: nil, update_mask: nil) -> ::Gapic::Operation
Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
def partial_update_instance(request, options = nil) -> ::Gapic::Operation
partial_update_instance
via a request object, either of type
PartialUpdateInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::PartialUpdateInstanceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def partial_update_instance(instance: nil, update_mask: nil) -> ::Gapic::Operation
partial_update_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- instance (::Google::Cloud::Bigtable::Admin::V2::Instance, ::Hash) — Required. The Instance which will (partially) replace the current value.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The subset of Instance fields which should be replaced. Must be explicitly set.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::PartialUpdateInstanceRequest.new # Call the partial_update_instance method. result = client.partial_update_instance request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Sets the access control policy on an instance resource. Replaces any existing policy.
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via a request object, either of type
Iam::V1::SetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
-
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. -
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
the fields in the mask will be modified. If no mask is provided, the
following default mask is used:
paths: "bindings, etag"
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::SetIamPolicyRequest.new # Call the set_iam_policy method. result = client.set_iam_policy request # The returned object is of type Google::Iam::V1::Policy. p result
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via a request object, either of type
Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
- request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
-
permissions (::Array<::String>) — The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Iam::V1::TestIamPermissionsRequest.new # Call the test_iam_permissions method. result = client.test_iam_permissions request # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_app_profile
def update_app_profile(request, options = nil) -> ::Gapic::Operation
def update_app_profile(app_profile: nil, update_mask: nil, ignore_warnings: nil) -> ::Gapic::Operation
Updates an app profile within an instance.
def update_app_profile(request, options = nil) -> ::Gapic::Operation
update_app_profile
via a request object, either of type
UpdateAppProfileRequest or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::UpdateAppProfileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_app_profile(app_profile: nil, update_mask: nil, ignore_warnings: nil) -> ::Gapic::Operation
update_app_profile
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- app_profile (::Google::Cloud::Bigtable::Admin::V2::AppProfile, ::Hash) — Required. The app profile which will (partially) replace the current value.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.
- ignore_warnings (::Boolean) — If true, ignore safety checks when updating the app profile.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::UpdateAppProfileRequest.new # Call the update_app_profile method. result = client.update_app_profile request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#update_cluster
def update_cluster(request, options = nil) -> ::Gapic::Operation
def update_cluster(name: nil, location: nil, serve_nodes: nil, node_scaling_factor: nil, cluster_config: nil, default_storage_type: nil, encryption_config: nil) -> ::Gapic::Operation
Updates a cluster within an instance.
Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.
def update_cluster(request, options = nil) -> ::Gapic::Operation
update_cluster
via a request object, either of type
Cluster or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::Cluster, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_cluster(name: nil, location: nil, serve_nodes: nil, node_scaling_factor: nil, cluster_config: nil, default_storage_type: nil, encryption_config: nil) -> ::Gapic::Operation
update_cluster
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — The unique name of the cluster. Values are of the form
projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*
. -
location (::String) — Immutable. The location where this cluster's nodes and storage reside. For
best performance, clients should be located as close as possible to this
cluster. Currently only zones are supported, so values should be of the
form
projects/{project}/locations/{zone}
. - serve_nodes (::Integer) — The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
- node_scaling_factor (::Google::Cloud::Bigtable::Admin::V2::Cluster::NodeScalingFactor) — Immutable. The node scaling factor of this cluster.
- cluster_config (::Google::Cloud::Bigtable::Admin::V2::Cluster::ClusterConfig, ::Hash) — Configuration for this cluster.
- default_storage_type (::Google::Cloud::Bigtable::Admin::V2::StorageType) — Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
- encryption_config (::Google::Cloud::Bigtable::Admin::V2::Cluster::EncryptionConfig, ::Hash) — Immutable. The encryption configuration for CMEK-protected clusters.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::Cluster.new # Call the update_cluster method. result = client.update_cluster request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#update_instance
def update_instance(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
def update_instance(name: nil, display_name: nil, state: nil, type: nil, labels: nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
def update_instance(request, options = nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
update_instance
via a request object, either of type
Instance or an equivalent Hash.
- request (::Google::Cloud::Bigtable::Admin::V2::Instance, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_instance(name: nil, display_name: nil, state: nil, type: nil, labels: nil) -> ::Google::Cloud::Bigtable::Admin::V2::Instance
update_instance
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — The unique name of the instance. Values are of the form
projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]
. - display_name (::String) — Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
-
state (::Google::Cloud::Bigtable::Admin::V2::Instance::State) — (
OutputOnly
) The current state of the instance. -
type (::Google::Cloud::Bigtable::Admin::V2::Instance::Type) — The type of the instance. Defaults to
PRODUCTION
. -
labels (::Hash{::String => ::String}) —
Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.
- Label keys must be between 1 and 63 characters long and must conform to
the regular expression:
[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}
. - Label values must be between 0 and 63 characters long and must conform to
the regular expression:
[\p{Ll}\p{Lo}\p{N}_-]{0,63}
. - No more than 64 labels can be associated with a given resource.
- Keys and values must both be under 128 bytes.
- Label keys must be between 1 and 63 characters long and must conform to
the regular expression:
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigtable::Admin::V2::Instance)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/bigtable/admin/v2" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Bigtable::Admin::V2::Instance.new # Call the update_instance method. result = client.update_instance request # The returned object is of type Google::Cloud::Bigtable::Admin::V2::Instance. p result