Method: googleapis.spanner.v1.projects.instances.instancePartitions.delete

Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires spanner.instancePartitions.delete permission on the resource name.

For more information about retries and long-running operations, see Understand connectors.

Arguments

Parameters
name

string

Required. The name of the instance partition to be deleted. Values are of the form projects/{project}/instances/{instance}/instancePartitions/{instance_partition}
etag

string

Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- delete:
    call: googleapis.spanner.v1.projects.instances.instancePartitions.delete
    args:
        name: ...
        etag: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.spanner.v1.projects.instances.instancePartitions.delete",
      "args": {
        "name": "...",
        "etag": "..."
      },
      "result": "deleteResult"
    }
  }
]