- 3.46.0 (latest)
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
Summary of entries of Methods for spanner.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient
DatabaseAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the database admin client.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.backup_path
backup_path(project: str, instance: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.backup_path
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.copy_backup
copy_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.CopyBackupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
backup_id: typing.Optional[str] = None,
source_backup: typing.Optional[str] = None,
expire_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts copying a Cloud Spanner Backup.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.copy_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.CreateBackupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[
google.cloud.spanner_admin_database_v1.types.backup.Backup
] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts creating a new Cloud Spanner Backup.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_database
create_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.CreateDatabaseRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
create_statement: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Cloud Spanner database and starts to prepare it for serving.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_path
crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str
Returns a fully-qualified crypto_key string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_path
database_path(project: str, instance: str, database: str) -> str
Returns a fully-qualified database string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_role_path
database_role_path(project: str, instance: str, database: str, role: str) -> str
Returns a fully-qualified database_role string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.DeleteBackupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a pending or completed
Backup][google.spanner.admin.database.v1.Backup]
.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.drop_database
drop_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.DropDatabaseRequest,
dict,
]
] = None,
*,
database: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Drops (aka deletes) a Cloud Spanner database.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.GetBackupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup
Gets metadata on a pending or completed
Backup][google.spanner.admin.database.v1.Backup]
.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database
get_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database
Gets the state of a Cloud Spanner database.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database_ddl
get_database_ddl(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlRequest,
dict,
]
] = None,
*,
database: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlResponse
)
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for a database or backup resource.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport
]
)
Returns an appropriate transport class.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backup_operations
list_backup_operations(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager
)
Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager
)
Lists completed and pending backups.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backups
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_operations
list_database_operations(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager
)
Lists database
longrunning-operations][google.longrunning.Operation]
.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_roles
list_database_roles(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesAsyncPager
)
Lists Cloud Spanner database roles.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager
)
Lists Cloud Spanner databases.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_path
parse_crypto_key_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_role_path
parse_database_role_path(path: str) -> typing.Dict[str, str]
Parses a database_role path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.restore_database
restore_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.RestoreDatabaseRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
database_id: typing.Optional[str] = None,
backup: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create a new database by restoring from a completed backup.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on a database or backup resource.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified database or backup resource.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.UpdateBackupRequest,
dict,
]
] = None,
*,
backup: typing.Optional[
google.cloud.spanner_admin_database_v1.types.backup.Backup
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup
Updates a pending or completed
Backup][google.spanner.admin.database.v1.Backup]
.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database
update_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseRequest,
dict,
]
] = None,
*,
database: typing.Optional[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a Cloud Spanner database.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database_ddl
update_database_ddl(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseDdlRequest,
dict,
]
] = None,
*,
database: typing.Optional[str] = None,
statements: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient
DatabaseAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the database admin client.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.exit
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.backup_path
backup_path(project: str, instance: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.backup_path
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.cancel_operation
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.copy_backup
copy_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.CopyBackupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
backup_id: typing.Optional[str] = None,
source_backup: typing.Optional[str] = None,
expire_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts copying a Cloud Spanner Backup.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.copy_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.CreateBackupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[
google.cloud.spanner_admin_database_v1.types.backup.Backup
] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Starts creating a new Cloud Spanner Backup.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_database
create_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.CreateDatabaseRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
create_statement: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates a new Cloud Spanner database and starts to prepare it for serving.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_database
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_path
crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str
Returns a fully-qualified crypto_key string.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_path
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_path
database_path(project: str, instance: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_path
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_role_path
database_role_path(project: str, instance: str, database: str, role: str) -> str
Returns a fully-qualified database_role string.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.DeleteBackupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a pending or completed
Backup][google.spanner.admin.database.v1.Backup]
.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_operation
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.drop_database
drop_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.DropDatabaseRequest,
dict,
]
] = None,
*,
database: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Drops (aka deletes) a Cloud Spanner database.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.drop_database
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.GetBackupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup
Gets metadata on a pending or completed
Backup][google.spanner.admin.database.v1.Backup]
.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database
get_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database
Gets the state of a Cloud Spanner database.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database_ddl
get_database_ddl(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlRequest,
dict,
]
] = None,
*,
database: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlResponse
)
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database_ddl
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for a database or backup resource.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_iam_policy
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_operation
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.instance_path
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backup_operations
list_backup_operations(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager
)
Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager
)
Lists completed and pending backups.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backups
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_database_operations
list_database_operations(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager
)
Lists database
longrunning-operations][google.longrunning.Operation]
.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_database_roles
list_database_roles(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesPager
)
Lists Cloud Spanner database roles.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager
)
Lists Cloud Spanner databases.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_databases
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_operations
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_backup_path
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_crypto_key_path
parse_crypto_key_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_database_role_path
parse_database_role_path(path: str) -> typing.Dict[str, str]
Parses a database_role path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.restore_database
restore_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.RestoreDatabaseRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
database_id: typing.Optional[str] = None,
backup: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Create a new database by restoring from a completed backup.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.restore_database
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on a database or backup resource.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.set_iam_policy
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified database or backup resource.
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.backup.UpdateBackupRequest,
dict,
]
] = None,
*,
backup: typing.Optional[
google.cloud.spanner_admin_database_v1.types.backup.Backup
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup
Updates a pending or completed
Backup][google.spanner.admin.database.v1.Backup]
.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_backup
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database
update_database(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseRequest,
dict,
]
] = None,
*,
database: typing.Optional[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates a Cloud Spanner database.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database
google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database_ddl
update_database_ddl(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseDdlRequest,
dict,
]
] = None,
*,
database: typing.Optional[str] = None,
statements: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager
ListBackupOperationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse
],
],
request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest,
response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager
ListBackupOperationsPager(
method: typing.Callable[
[...],
google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse,
],
request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest,
response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager
ListBackupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse
],
],
request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest,
response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager
ListBackupsPager(
method: typing.Callable[
[...], google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse
],
request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest,
response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager
ListDatabaseOperationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse
],
],
request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest,
response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager
ListDatabaseOperationsPager(
method: typing.Callable[
[...],
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse,
],
request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest,
response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesAsyncPager
ListDatabaseRolesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse
],
],
request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesAsyncPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesPager
ListDatabaseRolesPager(
method: typing.Callable[
[...],
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse,
],
request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager
ListDatabasesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse
],
],
request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager
ListDatabasesPager(
method: typing.Callable[
[...],
google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
],
request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
*,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient
InstanceAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the instance admin client.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance_id: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an instance and begins preparing it to begin serving.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance_config
create_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance_config: typing.Optional[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
] = None,
instance_config_id: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates an instance config and begins preparing it to be used.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an instance.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance_config
delete_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes the instance config.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for an instance resource.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
Gets information about a particular instance.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance_config
get_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
Gets information about a particular instance configuration.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport
]
)
Returns an appropriate transport class.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_config_path
instance_config_path(project: str, instance_config: str) -> str
Returns a fully-qualified instance_config string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_config_operations
list_instance_config_operations(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsAsyncPager
)
Lists the user-managed instance config [long-running operations][google.longrunning.Operation] in the given project.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_configs
list_instance_configs(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager
)
Lists the supported instance configurations for a given project.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager
)
Lists all instances in the given project.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_config_path
parse_instance_config_path(path: str) -> typing.Dict[str, str]
Parses a instance_config path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on an instance resource.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceRequest,
dict,
]
] = None,
*,
instance: typing.Optional[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
] = None,
field_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an instance, and begins allocating or releasing resources as requested.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance_config
update_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceConfigRequest,
dict,
]
] = None,
*,
instance_config: typing.Optional[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an instance config.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient
InstanceAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the instance admin client.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.exit
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance_id: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an instance and begins preparing it to begin serving.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance_config
create_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceConfigRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance_config: typing.Optional[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
] = None,
instance_config_id: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation
Creates an instance config and begins preparing it to be used.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes an instance.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance_config
delete_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
Deletes the instance config.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for an instance resource.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_iam_policy
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
Gets information about a particular instance.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance_config
get_instance_config(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
Gets information about a particular instance configuration.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_config_path
instance_config_path(project: str, instance_config: str) -> str
Returns a fully-qualified instance_config string.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_path
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_config_operations
list_instance_config_operations(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsPager
)
Lists the user-managed instance config [long-running operations][google.longrunning.Operation] in the given project.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_configs
list_instance_configs(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager
)
Lists the supported instance configurations for a given project.
google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) ->