Method: googleapis.spanner.v1.projects.instances.databases.backupSchedules.patch

Updates a backup schedule.

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

Arguments

Parameters
name

string

Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form projects//instances//databases//backupSchedules/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.
updateMask

string (FieldMask format)

Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.
body

object (BackupSchedule)

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.

Response

If successful, the response contains an instance of BackupSchedule.

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.instances.databases.backupSchedules.patch
    args:
        name: ...
        updateMask: ...
        body:
            encryptionConfig:
                encryptionType: ...
                kmsKeyName: ...
                kmsKeyNames: ...
            fullBackupSpec: ...
            incrementalBackupSpec: ...
            retentionDuration: ...
            spec:
                cronSpec:
                    text: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.spanner.v1.projects.instances.databases.backupSchedules.patch",
      "args": {
        "name": "...",
        "updateMask": "...",
        "body": {
          "encryptionConfig": {
            "encryptionType": "...",
            "kmsKeyName": "...",
            "kmsKeyNames": "..."
          },
          "fullBackupSpec": "...",
          "incrementalBackupSpec": "...",
          "retentionDuration": "...",
          "spec": {
            "cronSpec": {
              "text": "..."
            }
          }
        }
      },
      "result": "patchResult"
    }
  }
]