googleapis/google/bigtable/admin/v2/bigtableadmin_v2.yaml
2025-08-19 17:37:13 -07:00

297 lines
15 KiB
YAML

type: google.api.Service
config_version: 3
name: bigtableadmin.googleapis.com
title: Cloud Bigtable Admin API
apis:
- name: google.bigtable.admin.v2.BigtableInstanceAdmin
- name: google.bigtable.admin.v2.BigtableTableAdmin
types:
- name: google.bigtable.admin.v2.Backup
- name: google.bigtable.admin.v2.CopyBackupMetadata
- name: google.bigtable.admin.v2.CreateAuthorizedViewMetadata
- name: google.bigtable.admin.v2.CreateBackupMetadata
- name: google.bigtable.admin.v2.CreateClusterMetadata
- name: google.bigtable.admin.v2.CreateInstanceMetadata
- name: google.bigtable.admin.v2.CreateLogicalViewMetadata
- name: google.bigtable.admin.v2.CreateMaterializedViewMetadata
- name: google.bigtable.admin.v2.CreateSchemaBundleMetadata
- name: google.bigtable.admin.v2.CreateTableFromSnapshotMetadata
- name: google.bigtable.admin.v2.OptimizeRestoredTableMetadata
- name: google.bigtable.admin.v2.PartialUpdateClusterMetadata
- name: google.bigtable.admin.v2.RestoreTableMetadata
- name: google.bigtable.admin.v2.SnapshotTableMetadata
- name: google.bigtable.admin.v2.UndeleteTableMetadata
- name: google.bigtable.admin.v2.UpdateAppProfileMetadata
- name: google.bigtable.admin.v2.UpdateAuthorizedViewMetadata
- name: google.bigtable.admin.v2.UpdateClusterMetadata
- name: google.bigtable.admin.v2.UpdateInstanceMetadata
- name: google.bigtable.admin.v2.UpdateLogicalViewMetadata
- name: google.bigtable.admin.v2.UpdateSchemaBundleMetadata
- name: google.bigtable.admin.v2.UpdateTableMetadata
documentation:
summary: Administer your Cloud Bigtable tables and instances.
backend:
rules:
- selector: 'google.bigtable.admin.v2.BigtableInstanceAdmin.*'
deadline: 60.0
- selector: 'google.bigtable.admin.v2.BigtableTableAdmin.*'
deadline: 60.0
- selector: google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
deadline: 130.0
- selector: google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
deadline: 900.0
- selector: 'google.longrunning.Operations.*'
deadline: 60.0
http:
rules:
- selector: google.longrunning.Operations.CancelOperation
post: '/v2/{name=operations/**}:cancel'
- selector: google.longrunning.Operations.DeleteOperation
delete: '/v2/{name=operations/**}'
- selector: google.longrunning.Operations.GetOperation
get: '/v2/{name=operations/**}'
- selector: google.longrunning.Operations.ListOperations
get: '/v2/{name=operations/projects/**}/operations'
authentication:
rules:
- selector: 'google.bigtable.admin.v2.BigtableInstanceAdmin.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform
- selector: google.bigtable.admin.v2.BigtableInstanceAdmin.GetAppProfile
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.bigtable.admin.v2.BigtableInstanceAdmin.GetCluster
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.bigtable.admin.v2.BigtableInstanceAdmin.GetInstance
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.bigtable.admin.v2.BigtableInstanceAdmin.ListClusters
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.bigtable.admin.v2.BigtableInstanceAdmin.ListHotTablets
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.bigtable.admin.v2.BigtableInstanceAdmin.ListInstances
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: 'google.bigtable.admin.v2.BigtableTableAdmin.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.table,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.table,
https://www.googleapis.com/auth/cloud-platform
- selector: google.bigtable.admin.v2.BigtableTableAdmin.GetTable
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.table,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.table,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.bigtable.admin.v2.BigtableTableAdmin.ListTables
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.table,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.table,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform
- selector: google.longrunning.Operations.GetOperation
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
- selector: google.longrunning.Operations.ListOperations
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/bigtable.admin,
https://www.googleapis.com/auth/bigtable.admin.cluster,
https://www.googleapis.com/auth/bigtable.admin.instance,
https://www.googleapis.com/auth/cloud-bigtable.admin,
https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
https://www.googleapis.com/auth/cloud-platform,
https://www.googleapis.com/auth/cloud-platform.read-only
publishing:
new_issue_uri: https://issuetracker.google.com/issues/new?component=127971
documentation_uri: https://cloud.google.com/bigtable/docs/overview
api_short_name: bigtableadmin
github_label: 'api: bigtable'
doc_tag_prefix: bigtableadmin
organization: CLOUD
library_settings:
- version: google.bigtable.admin.v2
launch_stage: GA
java_settings:
common:
destinations:
- PACKAGE_MANAGER
cpp_settings:
common:
destinations:
- PACKAGE_MANAGER
php_settings:
common:
destinations:
- PACKAGE_MANAGER
python_settings:
common:
destinations:
- PACKAGE_MANAGER
selective_gapic_generation:
methods:
- google.bigtable.admin.v2.BigtableInstanceAdmin.CreateAppProfile
- google.bigtable.admin.v2.BigtableInstanceAdmin.CreateCluster
- google.bigtable.admin.v2.BigtableInstanceAdmin.CreateInstance
- google.bigtable.admin.v2.BigtableInstanceAdmin.CreateLogicalView
- google.bigtable.admin.v2.BigtableInstanceAdmin.CreateMaterializedView
- google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteAppProfile
- google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteCluster
- google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteInstance
- google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteLogicalView
- google.bigtable.admin.v2.BigtableInstanceAdmin.DeleteMaterializedView
- google.bigtable.admin.v2.BigtableInstanceAdmin.GetAppProfile
- google.bigtable.admin.v2.BigtableInstanceAdmin.GetCluster
- google.bigtable.admin.v2.BigtableInstanceAdmin.GetIamPolicy
- google.bigtable.admin.v2.BigtableInstanceAdmin.GetInstance
- google.bigtable.admin.v2.BigtableInstanceAdmin.GetLogicalView
- google.bigtable.admin.v2.BigtableInstanceAdmin.GetMaterializedView
- google.bigtable.admin.v2.BigtableInstanceAdmin.ListAppProfiles
- google.bigtable.admin.v2.BigtableInstanceAdmin.ListClusters
- google.bigtable.admin.v2.BigtableInstanceAdmin.ListHotTablets
- google.bigtable.admin.v2.BigtableInstanceAdmin.ListInstances
- google.bigtable.admin.v2.BigtableInstanceAdmin.ListLogicalViews
- google.bigtable.admin.v2.BigtableInstanceAdmin.ListMaterializedViews
- google.bigtable.admin.v2.BigtableInstanceAdmin.PartialUpdateCluster
- google.bigtable.admin.v2.BigtableInstanceAdmin.PartialUpdateInstance
- google.bigtable.admin.v2.BigtableInstanceAdmin.SetIamPolicy
- google.bigtable.admin.v2.BigtableInstanceAdmin.TestIamPermissions
- google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateAppProfile
- google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateCluster
- google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateInstance
- google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateLogicalView
- google.bigtable.admin.v2.BigtableInstanceAdmin.UpdateMaterializedView
- google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
- google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup
- google.bigtable.admin.v2.BigtableTableAdmin.CreateAuthorizedView
- google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup
- google.bigtable.admin.v2.BigtableTableAdmin.CreateSchemaBundle
- google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
- google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot
- google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView
- google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackup
- google.bigtable.admin.v2.BigtableTableAdmin.DeleteSchemaBundle
- google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot
- google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable
- google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
- google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
- google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView
- google.bigtable.admin.v2.BigtableTableAdmin.GetBackup
- google.bigtable.admin.v2.BigtableTableAdmin.GetIamPolicy
- google.bigtable.admin.v2.BigtableTableAdmin.GetSchemaBundle
- google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot
- google.bigtable.admin.v2.BigtableTableAdmin.GetTable
- google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews
- google.bigtable.admin.v2.BigtableTableAdmin.ListBackups
- google.bigtable.admin.v2.BigtableTableAdmin.ListSchemaBundles
- google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots
- google.bigtable.admin.v2.BigtableTableAdmin.ListTables
- google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
- google.bigtable.admin.v2.BigtableTableAdmin.SetIamPolicy
- google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable
- google.bigtable.admin.v2.BigtableTableAdmin.TestIamPermissions
- google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable
- google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView
- google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackup
- google.bigtable.admin.v2.BigtableTableAdmin.UpdateSchemaBundle
- google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable
generate_omitted_as_internal: true
node_settings:
common:
destinations:
- PACKAGE_MANAGER
dotnet_settings:
common:
destinations:
- PACKAGE_MANAGER
ruby_settings:
common:
destinations:
- PACKAGE_MANAGER
go_settings:
common:
destinations:
- PACKAGE_MANAGER