backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	google.managedidentities.backups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The unique name of the Backup in the form of projects/{project_id}/locations/global/domains/{domain_name}/backups/{name}
createTime	string (google-datetime)	Output only. The time the backups was created.
labels	object	Optional. Resource labels to represent user provided metadata.
state	string	Output only. The current state of the backup. (STATE_UNSPECIFIED, CREATING, ACTIVE, FAILED, DELETING)
statusMessage	string	Output only. Additional information about the current status of this backup, if available.
type	string	Output only. Indicates whether it’s an on-demand backup or scheduled. (TYPE_UNSPECIFIED, ON_DEMAND, SCHEDULED)
updateTime	string (google-datetime)	Output only. Last update time.

list

Name	Datatype	Description
name	string	Output only. The unique name of the Backup in the form of projects/{project_id}/locations/global/domains/{domain_name}/backups/{name}
createTime	string (google-datetime)	Output only. The time the backups was created.
labels	object	Optional. Resource labels to represent user provided metadata.
state	string	Output only. The current state of the backup. (STATE_UNSPECIFIED, CREATING, ACTIVE, FAILED, DELETING)
statusMessage	string	Output only. Additional information about the current status of this backup, if available.
type	string	Output only. Indicates whether it’s an on-demand backup or scheduled. (TYPE_UNSPECIFIED, ON_DEMAND, SCHEDULED)
updateTime	string (google-datetime)	Output only. Last update time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, domainsId, backupsId		Gets details of a single Backup.
list	select	projectsId, domainsId	pageSize, pageToken, filter, orderBy	Lists Backup in a given project.
create	insert	projectsId, domainsId	backupId	Creates a Backup for a domain.
patch	update	projectsId, domainsId, backupsId	updateMask	Updates the labels for specified Backup.
delete	delete	projectsId, domainsId, backupsId		Deletes identified Backup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backupsId	string
domainsId	string
projectsId	string
backupId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Backup.

SELECT
name,
createTime,
labels,
state,
statusMessage,
type,
updateTime
FROM google.managedidentities.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND domainsId = '{{ domainsId }}' -- required
AND backupsId = '{{ backupsId }}' -- required
;

list

Lists Backup in a given project.

SELECT
name,
createTime,
labels,
state,
statusMessage,
type,
updateTime
FROM google.managedidentities.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND domainsId = '{{ domainsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a Backup for a domain.

INSERT INTO google.managedidentities.backups (
data__labels,
projectsId,
domainsId,
backupId
)
SELECT 
'{{ labels }}',
'{{ projectsId }}',
'{{ domainsId }}',
'{{ backupId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: backups
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the backups resource.
  - name: domainsId
    value: "{{ domainsId }}"
    description: Required parameter for the backups resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Resource labels to represent user provided metadata.
  - name: backupId
    value: "{{ backupId }}"

UPDATE examples

patch

Updates the labels for specified Backup.

UPDATE google.managedidentities.backups
SET 
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND domainsId = '{{ domainsId }}' --required
AND backupsId = '{{ backupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes identified Backup.

DELETE FROM google.managedidentities.backups
WHERE projectsId = '{{ projectsId }}' --required
AND domainsId = '{{ domainsId }}' --required
AND backupsId = '{{ backupsId }}' --required
;