Method: googleapis.compute.v1.regionCommitments.update

Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

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
`commitment`	`string` Required. Name of the commitment for which auto renew is being updated.
`project`	`string` Required. Project ID for this request.
`region`	`string` Required. Name of the region for this request.
`paths`	`string` (No description provided)
`requestId`	`string` An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
`updateMask`	`string (FieldMask format)` update_mask indicates fields to be updated as part of this request.
`body`	`object (Commitment)` 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

- update:
    call: googleapis.compute.v1.regionCommitments.update
    args:
        commitment: ...
        project: ...
        region: ...
        paths: ...
        requestId: ...
        updateMask: ...
        body:
            autoRenew: ...
            category: ...
            description: ...
            licenseResource:
                amount: ...
                coresPerLicense: ...
                license: ...
            mergeSourceCommitments: ...
            name: ...
            plan: ...
            reservations: ...
            resources: ...
            splitSourceCommitment: ...
            type: ...
    result: updateResult

JSON

[
  {
    "update": {
      "call": "googleapis.compute.v1.regionCommitments.update",
      "args": {
        "commitment": "...",
        "project": "...",
        "region": "...",
        "paths": "...",
        "requestId": "...",
        "updateMask": "...",
        "body": {
          "autoRenew": "...",
          "category": "...",
          "description": "...",
          "licenseResource": {
            "amount": "...",
            "coresPerLicense": "...",
            "license": "..."
          },
          "mergeSourceCommitments": "...",
          "name": "...",
          "plan": "...",
          "reservations": "...",
          "resources": "...",
          "splitSourceCommitment": "...",
          "type": "..."
        }
      },
      "result": "updateResult"
    }
  }
]