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

Creates a new backup schedule.

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

Arguments

Parameters
parent

string

Required. The name of the database that this backup schedule applies to.
backupScheduleId

string

Required. The Id to use for the backup schedule. The backup_schedule_id appended to parent forms the full backup schedule name of the form projects//instances//databases//backupSchedules/.
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

- create:
    call: googleapis.spanner.v1.projects.instances.databases.backupSchedules.create
    args:
        parent: ...
        backupScheduleId: ...
        body:
            encryptionConfig:
                encryptionType: ...
                kmsKeyName: ...
                kmsKeyNames: ...
            fullBackupSpec: ...
            incrementalBackupSpec: ...
            retentionDuration: ...
            spec:
                cronSpec:
                    text: ...
    result: createResult

JSON

[
  {
    "create": {
      "call": "googleapis.spanner.v1.projects.instances.databases.backupSchedules.create",
      "args": {
        "parent": "...",
        "backupScheduleId": "...",
        "body": {
          "encryptionConfig": {
            "encryptionType": "...",
            "kmsKeyName": "...",
            "kmsKeyNames": "..."
          },
          "fullBackupSpec": "...",
          "incrementalBackupSpec": "...",
          "retentionDuration": "...",
          "spec": {
            "cronSpec": {
              "text": "..."
            }
          }
        }
      },
      "result": "createResult"
    }
  }
]