Class: Google::Apis::BigtableadminV2::BigtableAdminService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::BigtableadminV2::BigtableAdminService
- Defined in:
- generated/google/apis/bigtableadmin_v2/service.rb
Overview
Cloud Bigtable Admin API
Administer your Cloud Bigtable tables and instances.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#cancel_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Starts asynchronous cancellation on a long-running operation.
-
#check_table_consistency(name, check_consistency_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::CheckConsistencyResponse
Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
-
#create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Create an instance within a project.
-
#create_project_instance_app_profile(parent, app_profile_object = nil, app_profile_id: nil, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::AppProfile
Creates an app profile within an instance.
-
#create_project_instance_cluster(parent, cluster_object = nil, cluster_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Creates a cluster within an instance.
-
#create_project_instance_cluster_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Starts creating a new Cloud Bigtable Backup.
-
#create_table(parent, create_table_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Table
Creates a new table in the specified instance.
-
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes a long-running operation.
-
#delete_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Delete an instance from a project.
-
#delete_project_instance_app_profile(name, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes an app profile from an instance.
-
#delete_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes a cluster from an instance.
-
#delete_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes a pending or completed Cloud Bigtable backup.
-
#delete_project_instance_table(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Permanently deletes a specified table and all of its data.
-
#drop_table_row_range(name, drop_row_range_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Permanently drop/delete a row range from a specified table.
-
#generate_table_consistency_token(name, generate_consistency_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.
-
#get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Gets the access control policy for a Table resource.
-
#get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Gets the access control policy for an instance resource.
-
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Gets the latest state of a long-running operation.
-
#get_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Instance
Gets information about an instance.
-
#get_project_instance_app_profile(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::AppProfile
Gets information about an app profile.
-
#get_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Cluster
Gets information about a cluster.
-
#get_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Backup
Gets metadata on a pending or completed Cloud Bigtable Backup.
-
#get_project_instance_table(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Table
Gets metadata information about the specified table.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Location
Gets information about a location.
-
#get_table_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Gets the access control policy for a Table resource.
-
#initialize ⇒ BigtableAdminService
constructor
A new instance of BigtableAdminService.
-
#list_operation_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_instance_app_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListAppProfilesResponse
Lists information about app profiles in an instance.
-
#list_project_instance_cluster_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListBackupsResponse
Lists Cloud Bigtable backups.
-
#list_project_instance_clusters(parent, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListClustersResponse
Lists information about clusters in an instance.
-
#list_project_instance_tables(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListTablesResponse
Lists all tables served from a specified instance.
-
#list_project_instances(parent, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListInstancesResponse
Lists information about instances in a project.
-
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListLocationsResponse
Lists information about the supported locations for this service.
-
#modify_table_column_families(name, modify_column_families_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Table
Performs a series of column family modifications on the specified table.
-
#partial_project_instance_update_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Partially updates an instance within a project.
-
#patch_project_instance_app_profile(name, app_profile_object = nil, ignore_warnings: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Updates an app profile within an instance.
-
#patch_project_instance_cluster_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Backup
Updates a pending or completed Cloud Bigtable Backup.
-
#restore_table(parent, restore_table_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Create a new table by restoring from a completed backup.
-
#set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Sets the access control policy on a Table resource.
-
#set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Sets the access control policy on an instance resource.
-
#set_table_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Sets the access control policy on a Table resource.
-
#test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::TestIamPermissionsResponse
Returns permissions that the caller has on the specified table resource.
-
#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
-
#test_table_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::TestIamPermissionsResponse
Returns permissions that the caller has on the specified table resource.
-
#update_project_instance(name, instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Instance
Updates an instance within a project.
-
#update_project_instance_cluster(name, cluster_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Updates a cluster within an instance.
Constructor Details
#initialize ⇒ BigtableAdminService
Returns a new instance of BigtableAdminService.
45 46 47 48 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 45 def initialize super('https://bigtableadmin.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#cancel_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Starts asynchronous cancellation on a long-running operation. The server makes
a best effort to cancel the operation, but success is not guaranteed. If the
server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Clients can use Operations.GetOperation or other methods to check whether the
cancellation succeeded or whether the operation completed despite cancellation.
On successful cancellation, the operation is not deleted; instead, it becomes
an operation with an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
77 78 79 80 81 82 83 84 85 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 77 def cancel_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:cancel', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#check_table_consistency(name, check_consistency_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::CheckConsistencyResponse
Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1224 def check_table_consistency(name, check_consistency_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:checkConsistency', ) command.request_representation = Google::Apis::BigtableadminV2::CheckConsistencyRequest::Representation command.request_object = check_consistency_request_object command.response_representation = Google::Apis::BigtableadminV2::CheckConsistencyResponse::Representation command.response_class = Google::Apis::BigtableadminV2::CheckConsistencyResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Create an instance within a project.
219 220 221 222 223 224 225 226 227 228 229 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 219 def create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/instances', ) command.request_representation = Google::Apis::BigtableadminV2::CreateInstanceRequest::Representation command.request_object = create_instance_request_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_instance_app_profile(parent, app_profile_object = nil, app_profile_id: nil, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::AppProfile
Creates an app profile within an instance.
534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 534 def create_project_instance_app_profile(parent, app_profile_object = nil, app_profile_id: nil, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/appProfiles', ) command.request_representation = Google::Apis::BigtableadminV2::AppProfile::Representation command.request_object = app_profile_object command.response_representation = Google::Apis::BigtableadminV2::AppProfile::Representation command.response_class = Google::Apis::BigtableadminV2::AppProfile command.params['parent'] = parent unless parent.nil? command.query['appProfileId'] = app_profile_id unless app_profile_id.nil? command.query['ignoreWarnings'] = ignore_warnings unless ignore_warnings.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_instance_cluster(parent, cluster_object = nil, cluster_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Creates a cluster within an instance.
724 725 726 727 728 729 730 731 732 733 734 735 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 724 def create_project_instance_cluster(parent, cluster_object = nil, cluster_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/clusters', ) command.request_representation = Google::Apis::BigtableadminV2::Cluster::Representation command.request_object = cluster_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['parent'] = parent unless parent.nil? command.query['clusterId'] = cluster_id unless cluster_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_instance_cluster_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
901 902 903 904 905 906 907 908 909 910 911 912 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 901 def create_project_instance_cluster_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/backups', ) command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation command.request_object = backup_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['parent'] = parent unless parent.nil? command.query['backupId'] = backup_id unless backup_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_table(parent, create_table_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Table
Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1259 def create_table(parent, create_table_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/tables', ) command.request_representation = Google::Apis::BigtableadminV2::CreateTableRequest::Representation command.request_object = create_table_request_object command.response_representation = Google::Apis::BigtableadminV2::Table::Representation command.response_class = Google::Apis::BigtableadminV2::Table command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes a long-running operation. This method indicates that the client is no
longer interested in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns google.rpc.Code.
UNIMPLEMENTED
.
110 111 112 113 114 115 116 117 118 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 110 def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Delete an instance from a project.
252 253 254 255 256 257 258 259 260 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 252 def delete_project_instance(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_app_profile(name, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes an app profile from an instance.
571 572 573 574 575 576 577 578 579 580 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 571 def delete_project_instance_app_profile(name, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['ignoreWarnings'] = ignore_warnings unless ignore_warnings.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes a cluster from an instance.
758 759 760 761 762 763 764 765 766 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 758 def delete_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Deletes a pending or completed Cloud Bigtable backup.
935 936 937 938 939 940 941 942 943 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 935 def delete_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_instance_table(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Permanently deletes a specified table and all of its data.
1292 1293 1294 1295 1296 1297 1298 1299 1300 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1292 def delete_project_instance_table(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#drop_table_row_range(name, drop_row_range_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Empty
Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1327 def drop_table_row_range(name, drop_row_range_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:dropRowRange', ) command.request_representation = Google::Apis::BigtableadminV2::DropRowRangeRequest::Representation command.request_object = drop_row_range_request_object command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation command.response_class = Google::Apis::BigtableadminV2::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#generate_table_consistency_token(name, generate_consistency_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1365 def generate_table_consistency_token(name, generate_consistency_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:generateConsistencyToken', ) command.request_representation = Google::Apis::BigtableadminV2::GenerateConsistencyTokenRequest::Representation command.request_object = generate_consistency_token_request_object command.response_representation = Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse::Representation command.response_class = Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 999 def get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::BigtableadminV2::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation command.response_class = Google::Apis::BigtableadminV2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::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.
316 317 318 319 320 321 322 323 324 325 326 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 316 def get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::BigtableadminV2::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation command.response_class = Google::Apis::BigtableadminV2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
141 142 143 144 145 146 147 148 149 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 141 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Instance
Gets information about an instance.
283 284 285 286 287 288 289 290 291 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 283 def get_project_instance(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Instance::Representation command.response_class = Google::Apis::BigtableadminV2::Instance command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_app_profile(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::AppProfile
Gets information about an app profile.
603 604 605 606 607 608 609 610 611 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 603 def get_project_instance_app_profile(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::AppProfile::Representation command.response_class = Google::Apis::BigtableadminV2::AppProfile command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Cluster
Gets information about a cluster.
789 790 791 792 793 794 795 796 797 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 789 def get_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Cluster::Representation command.response_class = Google::Apis::BigtableadminV2::Cluster command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Backup
Gets metadata on a pending or completed Cloud Bigtable Backup.
966 967 968 969 970 971 972 973 974 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 966 def get_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation command.response_class = Google::Apis::BigtableadminV2::Backup command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_instance_table(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Table
Gets metadata information about the specified table.
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1401 def get_project_instance_table(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Table::Representation command.response_class = Google::Apis::BigtableadminV2::Table command.params['name'] = name unless name.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Location
Gets information about a location.
1659 1660 1661 1662 1663 1664 1665 1666 1667 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1659 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) command.response_representation = Google::Apis::BigtableadminV2::Location::Representation command.response_class = Google::Apis::BigtableadminV2::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_table_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1435 def get_table_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::BigtableadminV2::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation command.response_class = Google::Apis::BigtableadminV2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_operation_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource
name schemes, such as users/*/operations
. To override the binding, API
services can add a binding such as "/v1/
name=users/*/operations"
to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 184 def list_operation_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}/operations', ) command.response_representation = Google::Apis::BigtableadminV2::ListOperationsResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_app_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListAppProfilesResponse
Lists information about app profiles in an instance.
645 646 647 648 649 650 651 652 653 654 655 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 645 def list_project_instance_app_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/appProfiles', ) command.response_representation = Google::Apis::BigtableadminV2::ListAppProfilesResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListAppProfilesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_cluster_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListBackupsResponse
Lists Cloud Bigtable backups. Returns both completed and pending backups.
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1071 def list_project_instance_cluster_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/backups', ) command.response_representation = Google::Apis::BigtableadminV2::ListBackupsResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListBackupsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_clusters(parent, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListClustersResponse
Lists information about clusters in an instance.
824 825 826 827 828 829 830 831 832 833 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 824 def list_project_instance_clusters(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/clusters', ) command.response_representation = Google::Apis::BigtableadminV2::ListClustersResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListClustersResponse command.params['parent'] = parent unless parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instance_tables(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListTablesResponse
Lists all tables served from a specified instance.
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1480 def list_project_instance_tables(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/tables', ) command.response_representation = Google::Apis::BigtableadminV2::ListTablesResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListTablesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_instances(parent, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListInstancesResponse
Lists information about instances in a project.
351 352 353 354 355 356 357 358 359 360 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 351 def list_project_instances(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/instances', ) command.response_representation = Google::Apis::BigtableadminV2::ListInstancesResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListInstancesResponse command.params['parent'] = parent unless parent.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::ListLocationsResponse
Lists information about the supported locations for this service.
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1695 def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}/locations', ) command.response_representation = Google::Apis::BigtableadminV2::ListLocationsResponse::Representation command.response_class = Google::Apis::BigtableadminV2::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#modify_table_column_families(name, modify_column_families_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Table
Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1519 def modify_table_column_families(name, modify_column_families_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+name}:modifyColumnFamilies', ) command.request_representation = Google::Apis::BigtableadminV2::ModifyColumnFamiliesRequest::Representation command.request_object = modify_column_families_request_object command.response_representation = Google::Apis::BigtableadminV2::Table::Representation command.response_class = Google::Apis::BigtableadminV2::Table command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#partial_project_instance_update_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::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.
388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 388 def partial_project_instance_update_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::BigtableadminV2::Instance::Representation command.request_object = instance_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_instance_app_profile(name, app_profile_object = nil, ignore_warnings: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Updates an app profile within an instance.
684 685 686 687 688 689 690 691 692 693 694 695 696 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 684 def patch_project_instance_app_profile(name, app_profile_object = nil, ignore_warnings: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::BigtableadminV2::AppProfile::Representation command.request_object = app_profile_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['name'] = name unless name.nil? command.query['ignoreWarnings'] = ignore_warnings unless ignore_warnings.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_instance_cluster_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Backup
Updates a pending or completed Cloud Bigtable Backup.
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1117 def patch_project_instance_cluster_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2/{+name}', ) command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation command.request_object = backup_object command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation command.response_class = Google::Apis::BigtableadminV2::Backup command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#restore_table(parent, restore_table_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Create a new table by restoring from a completed backup. The new table must be in the same instance as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1558 def restore_table(parent, restore_table_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+parent}/tables:restore', ) command.request_representation = Google::Apis::BigtableadminV2::RestoreTableRequest::Representation command.request_object = restore_table_request_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Sets the access control policy on a Table resource. Replaces any existing policy.
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1153 def set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::BigtableadminV2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation command.response_class = Google::Apis::BigtableadminV2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Sets the access control policy on an instance resource. Replaces any existing policy.
424 425 426 427 428 429 430 431 432 433 434 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 424 def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::BigtableadminV2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation command.response_class = Google::Apis::BigtableadminV2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_table_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Policy
Sets the access control policy on a Table resource. Replaces any existing policy.
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1593 def set_table_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::BigtableadminV2::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation command.response_class = Google::Apis::BigtableadminV2::Policy command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::TestIamPermissionsResponse
Returns permissions that the caller has on the specified table resource.
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1187 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
458 459 460 461 462 463 464 465 466 467 468 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 458 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#test_table_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::TestIamPermissionsResponse
Returns permissions that the caller has on the specified table resource.
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 1627 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_instance(name, instance_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::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.
494 495 496 497 498 499 500 501 502 503 504 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 494 def update_project_instance(name, instance_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2/{+name}', ) command.request_representation = Google::Apis::BigtableadminV2::Instance::Representation command.request_object = instance_object command.response_representation = Google::Apis::BigtableadminV2::Instance::Representation command.response_class = Google::Apis::BigtableadminV2::Instance command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_instance_cluster(name, cluster_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigtableadminV2::Operation
Updates a cluster within an instance.
857 858 859 860 861 862 863 864 865 866 867 |
# File 'generated/google/apis/bigtableadmin_v2/service.rb', line 857 def update_project_instance_cluster(name, cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v2/{+name}', ) command.request_representation = Google::Apis::BigtableadminV2::Cluster::Representation command.request_object = cluster_object command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation command.response_class = Google::Apis::BigtableadminV2::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |