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

Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns NOT_FOUND. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a CANCELLED status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format /operations/ and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires spanner.instanceConfigs.update permission on the resource name.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
name	string Required. A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*.
body	object (UpdateInstanceConfigRequest) Required.

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.
OperationError	If the long-running operation finished unsuccessfully.
ResponseTypeError	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

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

YAML

- patch:
    call: googleapis.spanner.v1.projects.instanceConfigs.patch
    args:
        name: ...
        body:
            instanceConfig:
                baseConfig: ...
                displayName: ...
                etag: ...
                labels: ...
                leaderOptions: ...
                name: ...
                replicas: ...
            updateMask: ...
            validateOnly: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.spanner.v1.projects.instanceConfigs.patch",
      "args": {
        "name": "...",
        "body": {
          "instanceConfig": {
            "baseConfig": "...",
            "displayName": "...",
            "etag": "...",
            "labels": "...",
            "leaderOptions": "...",
            "name": "...",
            "replicas": "..."
          },
          "updateMask": "...",
          "validateOnly": "..."
        }
      },
      "result": "patchResult"
    }
  }
]