Get
|
|||||
|
|
Retrieves all information of the specified resource policy
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 3 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
region Required |
STRING |
Name of the region for this request |
resourcePolicy Required |
STRING |
Name of the resource policy to retrieve |
= Parameter name
= Format
project STRING Required Project ID for this request |
region STRING Required Name of the region for this request |
resourcePolicy STRING Required Name of the resource policy to retrieve |
Output
This building block provides 27 output parameters
Name | Format | Description |
---|---|---|
creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
description |
STRING |
|
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind |
STRING |
[Output Only] Type of the resource. Always compute#resource_policies for resource policies |
name |
STRING |
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
region |
STRING |
|
selfLink |
STRING |
[Output Only] Server-defined fully-qualified URL for this resource |
snapshotSchedulePolicy |
OBJECT |
A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained |
snapshotSchedulePolicy.retentionPolicy |
OBJECT |
Policy for retention of scheduled snapshots |
snapshotSchedulePolicy.retentionPolicy.maxRetentionDays |
INTEGER |
Maximum age of the snapshot that is allowed to be kept |
snapshotSchedulePolicy.retentionPolicy.onSourceDiskDelete |
ENUMERATION |
Specifies the behavior to apply to scheduled snapshots when the source disk is deleted |
snapshotSchedulePolicy.schedule |
OBJECT |
A schedule for disks where the schedueled operations are performed |
snapshotSchedulePolicy.schedule.dailySchedule |
OBJECT |
Time window specified for daily operations |
snapshotSchedulePolicy.schedule.dailySchedule.daysInCycle |
INTEGER |
Defines a schedule that runs every nth day of the month |
snapshotSchedulePolicy.schedule.dailySchedule.duration |
STRING |
[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario |
snapshotSchedulePolicy.schedule.dailySchedule.startTime |
STRING |
Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid |
snapshotSchedulePolicy.schedule.hourlySchedule |
OBJECT |
Time window specified for hourly operations |
snapshotSchedulePolicy.schedule.hourlySchedule.duration |
STRING |
[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario |
snapshotSchedulePolicy.schedule.hourlySchedule.hoursInCycle |
INTEGER |
Allows to define schedule that runs every nth hour |
snapshotSchedulePolicy.schedule.hourlySchedule.startTime |
STRING |
Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT |
snapshotSchedulePolicy.schedule.weeklySchedule |
OBJECT |
Time window specified for weekly operations |
snapshotSchedulePolicy.snapshotProperties |
OBJECT |
Specified snapshot properties for scheduled snapshots created by this policy |
snapshotSchedulePolicy.snapshotProperties.guestFlush |
BOOLEAN |
Indication to perform a ?guest aware? snapshot |
snapshotSchedulePolicy.snapshotProperties.labels |
OBJECT |
Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty |
snapshotSchedulePolicy.snapshotProperties.labels.customKey.value |
STRING |
Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty |
snapshotSchedulePolicy.snapshotProperties.storageLocations[] |
STRING |
|
status |
ENUMERATION |
[Output Only] The status of resource policy creation |
= Parameter name
= Format
creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
description STRING |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind STRING [Output Only] Type of the resource. Always compute#resource_policies for resource policies |
name STRING The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression |
region STRING |
selfLink STRING [Output Only] Server-defined fully-qualified URL for this resource |
snapshotSchedulePolicy OBJECT A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained |
snapshotSchedulePolicy.retentionPolicy OBJECT Policy for retention of scheduled snapshots |
snapshotSchedulePolicy.retentionPolicy.maxRetentionDays INTEGER Maximum age of the snapshot that is allowed to be kept |
snapshotSchedulePolicy.retentionPolicy.onSourceDiskDelete ENUMERATION Specifies the behavior to apply to scheduled snapshots when the source disk is deleted |
snapshotSchedulePolicy.schedule OBJECT A schedule for disks where the schedueled operations are performed |
snapshotSchedulePolicy.schedule.dailySchedule OBJECT Time window specified for daily operations |
snapshotSchedulePolicy.schedule.dailySchedule.daysInCycle INTEGER Defines a schedule that runs every nth day of the month |
snapshotSchedulePolicy.schedule.dailySchedule.duration STRING [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario |
snapshotSchedulePolicy.schedule.dailySchedule.startTime STRING Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid |
snapshotSchedulePolicy.schedule.hourlySchedule OBJECT Time window specified for hourly operations |
snapshotSchedulePolicy.schedule.hourlySchedule.duration STRING [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario |
snapshotSchedulePolicy.schedule.hourlySchedule.hoursInCycle INTEGER Allows to define schedule that runs every nth hour |
snapshotSchedulePolicy.schedule.hourlySchedule.startTime STRING Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT |
snapshotSchedulePolicy.schedule.weeklySchedule OBJECT Time window specified for weekly operations |
snapshotSchedulePolicy.snapshotProperties OBJECT Specified snapshot properties for scheduled snapshots created by this policy |
snapshotSchedulePolicy.snapshotProperties.guestFlush BOOLEAN Indication to perform a ?guest aware? snapshot |
snapshotSchedulePolicy.snapshotProperties.labels OBJECT Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty |
snapshotSchedulePolicy.snapshotProperties.labels.customKey.value STRING Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty |
snapshotSchedulePolicy.snapshotProperties.storageLocations[] STRING |
status ENUMERATION [Output Only] The status of resource policy creation |