2024-07-18
▼ ▲ spanner.projects.instances.databases.backupSchedules.create
Path: v1/{+parent}/backupSchedules
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the database that this backup schedule applies to.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
backupScheduleId
Description: 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/`.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new backup schedule.
▼ ▲ spanner.projects.instances.databases.backupSchedules.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets backup schedule for the input schedule name.
▼ ▲ spanner.projects.instances.databases.backupSchedules.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method: PATCH
Parameters:
name
Description: 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.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates a backup schedule.
▼ ▲ spanner.projects.instances.databases.backupSchedules.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes a backup schedule.
▼ ▲ spanner.projects.instances.databases.backupSchedules.list
Path: v1/{+parent}/backupSchedules
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules
HTTP Method: GET
Parameters:
parent
Description: Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Lists all the backup schedules for the database.
▼ ▲ spanner.projects.instances.databases.backupSchedules.create
Path: v1/{+parent}/backupSchedules
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the database that this backup schedule applies to.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
backupScheduleId
Description: 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/`.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new backup schedule.
▼ ▲ spanner.projects.instances.databases.backupSchedules.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets backup schedule for the input schedule name.
▼ ▲ spanner.projects.instances.databases.backupSchedules.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method: PATCH
Parameters:
name
Description: 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.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates a backup schedule.
▼ ▲ spanner.projects.instances.databases.backupSchedules.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`.
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes a backup schedule.
▼ ▲ spanner.projects.instances.databases.backupSchedules.list
Path: v1/{+parent}/backupSchedules
Flat Path: v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules
HTTP Method: GET
Parameters:
parent
Description: Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/
Pattern: ^projects/[^/]+/instances/[^/]+/databases/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Lists all the backup schedules for the database.