InstanceAdmin¶
- class google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
Cloud Spanner Instance Admin API The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases. Each instance has a “configuration”, which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.
Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.
Instantiates the instance admin client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, InstanceAdminTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_folder_path(folder: str) str ¶
Returns a fully-qualified folder string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static common_project_path(project: str) str ¶
Returns a fully-qualified project string.
- async create_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, instance: Optional[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates an instance and begins preparing it to begin serving. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists,
CreateInstance
returnsALREADY_EXISTS
.Immediately upon completion of this request:
The instance is readable via the API, with all requested attributes but no allocated resources. Its state is
CREATING
.
Until completion of the returned operation:
Cancelling the operation renders the instance immediately unreadable via the API.
The instance can be deleted.
All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
Databases can be created in the instance.
The instance’s allocated resource levels are readable via the API.
The instance’s state becomes
READY
.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format
<instance_name>/operations/<operation_id>
and can be used to track creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.CreateInstanceRequest, dict]) – The request object. The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
parent (
str
) –Required. The name of the project in which to create the instance. Values are of the form
projects/<project>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.instance_id (
str
) –Required. The ID of the instance to create. Valid identifiers are of the form
[a-z][-a-z0-9]*[a-z0-9]
and must be between 2 and 64 characters in length.This corresponds to the
instance_id
field on therequest
instance; ifrequest
is provided, this should not be set.instance (
google.cloud.spanner_admin_instance_v1.types.Instance
) –Required. The instance to create. The name may be omitted, but if specified must be
<parent>/instances/<instance_id>
.This corresponds to the
instance
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_instance_v1.types.Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.- Return type
google.api_core.operation_async.AsyncOperation
- async delete_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an instance.
Immediately upon completion of the request:
Billing ceases for all of the instance’s reserved resources.
Soon afterward:
The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.DeleteInstanceRequest, dict]) – The request object. The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
name (
str
) –Required. The name of the instance to be deleted. Values are of the form
projects/<project>/instances/<instance>
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Authorization requires
spanner.instances.getIamPolicy
on [resource][google.iam.v1.GetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.
resource (
str
) –REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- async get_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance [source]¶
Gets information about a particular instance.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.GetInstanceRequest, dict]) – The request object. The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
name (
str
) –Required. The name of the requested instance. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An isolated set of Cloud Spanner resources on which databases can be hosted.
- Return type
- async get_instance_config(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig [source]¶
Gets information about a particular instance configuration.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.GetInstanceConfigRequest, dict]) – The request object. The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
name (
str
) –Required. The name of the requested instance configuration. Values are of the form
projects/<project>/instanceConfigs/<config>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
- Return type
- get_transport_class() Type[google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- static instance_config_path(project: str, instance_config: str) str ¶
Returns a fully-qualified instance_config string.
- static instance_path(project: str, instance: str) str ¶
Returns a fully-qualified instance string.
- async list_instance_configs(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager [source]¶
Lists the supported instance configurations for a given project.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest, dict]) – The request object. The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
parent (
str
) –Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form
projects/<project>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager
- async list_instances(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager [source]¶
Lists all instances in the given project.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest, dict]) – The request object. The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
parent (
str
) –Required. The name of the project for which a list of instances is requested. Values are of the form
projects/<project>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_instance_config_path(path: str) Dict[str, str] ¶
Parses a instance_config path into its component segments.
- static parse_instance_path(path: str) Dict[str, str] ¶
Parses a instance path into its component segments.
- async set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets the access control policy on an instance resource. Replaces any existing policy.
Authorization requires
spanner.instances.setIamPolicy
on [resource][google.iam.v1.SetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.
resource (
str
) –REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- async test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
Returns permissions that the caller has on the specified instance resource.
Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has
spanner.instances.list
permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.- Parameters
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.
resource (
str
) –REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (
Sequence[str]
) –The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.This corresponds to the
permissions
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
InstanceAdminTransport
- async update_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceRequest, dict]] = None, *, instance: Optional[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance] = None, field_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Updates an instance, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns
NOT_FOUND
.Immediately upon completion of this request:
For resource types for which a decrease in the instance’s allocation has been requested, billing is based on the newly-requested level.
Until completion of the returned operation:
Cancelling the operation sets its metadata’s [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a
CANCELLED
status.All other attempts to modify the instance are rejected.
Reading the instance via the API continues to give the pre-request resource levels.
Upon completion of the returned operation:
Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
All newly-reserved resources are available for serving the instance’s tables.
The instance’s new resource levels are readable via the API.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format
<instance_name>/operations/<operation_id>
and can be used to track the instance modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.Authorization requires
spanner.instances.update
permission on resource [name][google.spanner.admin.instance.v1.Instance.name].- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.UpdateInstanceRequest, dict]) – The request object. The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
instance (
google.cloud.spanner_admin_instance_v1.types.Instance
) –Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
This corresponds to the
instance
field on therequest
instance; ifrequest
is provided, this should not be set.field_mask (
google.protobuf.field_mask_pb2.FieldMask
) –Required. A mask specifying which fields in [Instance][google.spanner.admin.instance.v1.Instance] should be updated. The field mask must always be specified; this prevents any future fields in [Instance][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them.
This corresponds to the
field_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_instance_v1.types.Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.- Return type
google.api_core.operation_async.AsyncOperation
- class google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
Cloud Spanner Instance Admin API The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases. Each instance has a “configuration”, which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.
Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.
Instantiates the instance admin client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, InstanceAdminTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, instance: Optional[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates an instance and begins preparing it to begin serving. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists,
CreateInstance
returnsALREADY_EXISTS
.Immediately upon completion of this request:
The instance is readable via the API, with all requested attributes but no allocated resources. Its state is
CREATING
.
Until completion of the returned operation:
Cancelling the operation renders the instance immediately unreadable via the API.
The instance can be deleted.
All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
Databases can be created in the instance.
The instance’s allocated resource levels are readable via the API.
The instance’s state becomes
READY
.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format
<instance_name>/operations/<operation_id>
and can be used to track creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.CreateInstanceRequest, dict]) – The request object. The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
parent (str) –
Required. The name of the project in which to create the instance. Values are of the form
projects/<project>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.instance_id (str) –
Required. The ID of the instance to create. Valid identifiers are of the form
[a-z][-a-z0-9]*[a-z0-9]
and must be between 2 and 64 characters in length.This corresponds to the
instance_id
field on therequest
instance; ifrequest
is provided, this should not be set.instance (google.cloud.spanner_admin_instance_v1.types.Instance) –
Required. The instance to create. The name may be omitted, but if specified must be
<parent>/instances/<instance_id>
.This corresponds to the
instance
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_instance_v1.types.Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.- Return type
google.api_core.operation.Operation
- delete_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an instance.
Immediately upon completion of the request:
Billing ceases for all of the instance’s reserved resources.
Soon afterward:
The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.DeleteInstanceRequest, dict]) – The request object. The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
name (str) –
Required. The name of the instance to be deleted. Values are of the form
projects/<project>/instances/<instance>
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Authorization requires
spanner.instances.getIamPolicy
on [resource][google.iam.v1.GetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.
resource (str) –
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- get_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance [source]¶
Gets information about a particular instance.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.GetInstanceRequest, dict]) – The request object. The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
name (str) –
Required. The name of the requested instance. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An isolated set of Cloud Spanner resources on which databases can be hosted.
- Return type
- get_instance_config(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig [source]¶
Gets information about a particular instance configuration.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.GetInstanceConfigRequest, dict]) – The request object. The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
name (str) –
Required. The name of the requested instance configuration. Values are of the form
projects/<project>/instanceConfigs/<config>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
- Return type
- static instance_config_path(project: str, instance_config: str) str [source]¶
Returns a fully-qualified instance_config string.
- static instance_path(project: str, instance: str) str [source]¶
Returns a fully-qualified instance string.
- list_instance_configs(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager [source]¶
Lists the supported instance configurations for a given project.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest, dict]) – The request object. The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
parent (str) –
Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form
projects/<project>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager
- list_instances(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager [source]¶
Lists all instances in the given project.
- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest, dict]) – The request object. The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
parent (str) –
Required. The name of the project for which a list of instances is requested. Values are of the form
projects/<project>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_instance_config_path(path: str) Dict[str, str] [source]¶
Parses a instance_config path into its component segments.
- static parse_instance_path(path: str) Dict[str, str] [source]¶
Parses a instance path into its component segments.
- set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
Sets the access control policy on an instance resource. Replaces any existing policy.
Authorization requires
spanner.instances.setIamPolicy
on [resource][google.iam.v1.SetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.
resource (str) –
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
Returns permissions that the caller has on the specified instance resource.
Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has
spanner.instances.list
permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.- Parameters
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.
resource (str) –
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (Sequence[str]) –
The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ‘storage.*’) are not allowed. For more information see IAM Overview.This corresponds to the
permissions
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
InstanceAdminTransport
- update_instance(request: Optional[Union[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceRequest, dict]] = None, *, instance: Optional[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance] = None, field_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Updates an instance, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns
NOT_FOUND
.Immediately upon completion of this request:
For resource types for which a decrease in the instance’s allocation has been requested, billing is based on the newly-requested level.
Until completion of the returned operation:
Cancelling the operation sets its metadata’s [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a
CANCELLED
status.All other attempts to modify the instance are rejected.
Reading the instance via the API continues to give the pre-request resource levels.
Upon completion of the returned operation:
Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
All newly-reserved resources are available for serving the instance’s tables.
The instance’s new resource levels are readable via the API.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format
<instance_name>/operations/<operation_id>
and can be used to track the instance modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is [Instance][google.spanner.admin.instance.v1.Instance], if successful.Authorization requires
spanner.instances.update
permission on resource [name][google.spanner.admin.instance.v1.Instance.name].- Parameters
request (Union[google.cloud.spanner_admin_instance_v1.types.UpdateInstanceRequest, dict]) – The request object. The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
instance (google.cloud.spanner_admin_instance_v1.types.Instance) –
Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
This corresponds to the
instance
field on therequest
instance; ifrequest
is provided, this should not be set.field_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. A mask specifying which fields in [Instance][google.spanner.admin.instance.v1.Instance] should be updated. The field mask must always be specified; this prevents any future fields in [Instance][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them.
This corresponds to the
field_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_instance_v1.types.Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.- Return type
google.api_core.operation.Operation
- class google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse]], request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest, response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_instance_configs
requests.This class thinly wraps an initial
google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse
object, and provides an__aiter__
method to iterate through itsinstance_configs
field.If there are more pages, the
__aiter__
method will make additionalListInstanceConfigs
requests and continue to iterate through theinstance_configs
field on the corresponding responses.All the usual
google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest) – The initial request object.
response (google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager(method: Callable[[...], google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse], request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest, response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_instance_configs
requests.This class thinly wraps an initial
google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse
object, and provides an__iter__
method to iterate through itsinstance_configs
field.If there are more pages, the
__iter__
method will make additionalListInstanceConfigs
requests and continue to iterate through theinstance_configs
field on the corresponding responses.All the usual
google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest) – The initial request object.
response (google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse]], request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest, response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_instances
requests.This class thinly wraps an initial
google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse
object, and provides an__aiter__
method to iterate through itsinstances
field.If there are more pages, the
__aiter__
method will make additionalListInstances
requests and continue to iterate through theinstances
field on the corresponding responses.All the usual
google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest) – The initial request object.
response (google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager(method: Callable[[...], google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse], request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest, response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_instances
requests.This class thinly wraps an initial
google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse
object, and provides an__iter__
method to iterate through itsinstances
field.If there are more pages, the
__iter__
method will make additionalListInstances
requests and continue to iterate through theinstances
field on the corresponding responses.All the usual
google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest) – The initial request object.
response (google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.