Method: googleapis.spanner.v1.projects.instanceConfigs.delete

Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns FAILED_PRECONDITION. Only user-managed configurations can be deleted. Authorization requires spanner.instanceConfigs.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 configuration to be deleted. Values are of the form projects//instanceConfigs/
etag

string

Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration.
validateOnly

boolean

An option to validate, but not actually execute, a request, and provide the same response.

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.instanceConfigs.delete
    args:
        name: ...
        etag: ...
        validateOnly: ...
    result: deleteResult

JSON

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