1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.resourcePolicies.html">resourcePolicies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79<p class="firstline">Retrieves an aggregated list of resource policies.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(project, region, resourcePolicy, requestId=None)</a></code></p> 85<p class="firstline">Deletes the specified resource policy.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, region, resourcePolicy)</a></code></p> 88<p class="firstline">Retrieves all information of the specified resource policy.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a new resource policy.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">A list all the resource policies that have been configured for the specified project in specified region.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p> 100<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 104 <pre>Retrieves an aggregated list of resource policies. 105 106Args: 107 project: string, Project ID for this request. (required) 108 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 109 110You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 111 112Currently, only sorting by name or creationTimestamp desc is supported. 113 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 114 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. 115 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 116 117For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 118 119You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 120 121To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 122 123Returns: 124 An object of the form: 125 126 { # Contains a list of resourcePolicies. 127 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 128 "kind": "compute#resourcePolicyAggregatedList", # Type of resource. 129 "items": { # A list of ResourcePolicy resources. 130 "a_key": { # Name of the scope containing this set of resourcePolicies. 131 "resourcePolicies": [ # A list of resourcePolicies contained in this scope. 132 { 133 "status": "A String", # [Output Only] The status of resource policy creation. 134 "kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies. 135 "description": "A String", 136 "region": "A String", 137 "snapshotSchedulePolicy": { # 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. # Resource policy for persistent disks for creating snapshots. 138 "snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys. 139 "guestFlush": True or False, # Indication to perform a ?guest aware? snapshot. 140 "storageLocations": [ # GCS bucket storage location of the auto snapshot (regional or multi-regional). 141 "A String", 142 ], 143 "labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. 144 "a_key": "A String", 145 }, 146 }, 147 "retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy. 148 "onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. 149 "maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept. 150 }, 151 "schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. 152 "weeklySchedule": { # Time window specified for weekly operations. 153 "dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week. 154 { 155 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 156 "day": "A String", # Allows to define schedule that runs specified day of the week. 157 "startTime": "A 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. 158 }, 159 ], 160 }, 161 "hourlySchedule": { # Time window specified for hourly operations. 162 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 163 "hoursInCycle": 42, # Allows to define schedule that runs every nth hour. 164 "startTime": "A 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. 165 }, 166 "dailySchedule": { # Time window specified for daily operations. 167 "duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. 168 "daysInCycle": 42, # Defines a schedule that runs every nth day of the month. 169 "startTime": "A 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. 170 }, 171 }, 172 }, 173 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 174 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 175 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 176 "name": "A 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 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 177 }, 178 ], 179 "warning": { # Informational warning which replaces the list of resourcePolicies when the list is empty. 180 "message": "A String", # [Output Only] A human-readable description of the warning code. 181 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 182 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 183 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 184 { 185 "value": "A String", # [Output Only] A warning data value corresponding to the key. 186 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 187 }, 188 ], 189 }, 190 }, 191 }, 192 "etag": "A String", 193 "warning": { # [Output Only] Informational warning message. 194 "message": "A String", # [Output Only] A human-readable description of the warning code. 195 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 196 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 197 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 198 { 199 "value": "A String", # [Output Only] A warning data value corresponding to the key. 200 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 201 }, 202 ], 203 }, 204 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 205 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 206 }</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 211 <pre>Retrieves the next page of results. 212 213Args: 214 previous_request: The request for the previous page. (required) 215 previous_response: The response from the request for the previous page. (required) 216 217Returns: 218 A request object that you can call 'execute()' on to request the next 219 page. Returns None if there are no more items in the collection. 220 </pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="delete">delete(project, region, resourcePolicy, requestId=None)</code> 225 <pre>Deletes the specified resource policy. 226 227Args: 228 project: string, Project ID for this request. (required) 229 region: string, Name of the region for this request. (required) 230 resourcePolicy: string, Name of the resource policy to delete. (required) 231 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 232 233For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 234 235The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 236 237Returns: 238 An object of the form: 239 240 { # Represents an Operation resource. 241 # 242 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 243 # 244 # Operations can be global, regional or zonal. 245 # - For global operations, use the globalOperations resource. 246 # - For regional operations, use the regionOperations resource. 247 # - For zonal operations, use the zonalOperations resource. 248 # 249 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 250 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 251 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 252 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 253 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 254 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 255 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 256 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 257 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 258 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 259 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 260 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 261 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 262 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 263 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 264 { 265 "message": "A String", # [Output Only] A human-readable description of the warning code. 266 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 267 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 268 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 269 { 270 "value": "A String", # [Output Only] A warning data value corresponding to the key. 271 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 272 }, 273 ], 274 }, 275 ], 276 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 277 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 278 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 279 "name": "A String", # [Output Only] Name of the resource. 280 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 281 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 282 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 283 { 284 "message": "A String", # [Output Only] An optional, human-readable error message. 285 "code": "A String", # [Output Only] The error type identifier for this error. 286 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 287 }, 288 ], 289 }, 290 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 291 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 292 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 293 }</pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="get">get(project, region, resourcePolicy)</code> 298 <pre>Retrieves all information of the specified resource policy. 299 300Args: 301 project: string, Project ID for this request. (required) 302 region: string, Name of the region for this request. (required) 303 resourcePolicy: string, Name of the resource policy to retrieve. (required) 304 305Returns: 306 An object of the form: 307 308 { 309 "status": "A String", # [Output Only] The status of resource policy creation. 310 "kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies. 311 "description": "A String", 312 "region": "A String", 313 "snapshotSchedulePolicy": { # 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. # Resource policy for persistent disks for creating snapshots. 314 "snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys. 315 "guestFlush": True or False, # Indication to perform a ?guest aware? snapshot. 316 "storageLocations": [ # GCS bucket storage location of the auto snapshot (regional or multi-regional). 317 "A String", 318 ], 319 "labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. 320 "a_key": "A String", 321 }, 322 }, 323 "retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy. 324 "onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. 325 "maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept. 326 }, 327 "schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. 328 "weeklySchedule": { # Time window specified for weekly operations. 329 "dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week. 330 { 331 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 332 "day": "A String", # Allows to define schedule that runs specified day of the week. 333 "startTime": "A 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. 334 }, 335 ], 336 }, 337 "hourlySchedule": { # Time window specified for hourly operations. 338 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 339 "hoursInCycle": 42, # Allows to define schedule that runs every nth hour. 340 "startTime": "A 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. 341 }, 342 "dailySchedule": { # Time window specified for daily operations. 343 "duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. 344 "daysInCycle": 42, # Defines a schedule that runs every nth day of the month. 345 "startTime": "A 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. 346 }, 347 }, 348 }, 349 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 350 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 351 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 352 "name": "A 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 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 353 }</pre> 354</div> 355 356<div class="method"> 357 <code class="details" id="insert">insert(project, region, body, requestId=None)</code> 358 <pre>Creates a new resource policy. 359 360Args: 361 project: string, Project ID for this request. (required) 362 region: string, Name of the region for this request. (required) 363 body: object, The request body. (required) 364 The object takes the form of: 365 366{ 367 "status": "A String", # [Output Only] The status of resource policy creation. 368 "kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies. 369 "description": "A String", 370 "region": "A String", 371 "snapshotSchedulePolicy": { # 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. # Resource policy for persistent disks for creating snapshots. 372 "snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys. 373 "guestFlush": True or False, # Indication to perform a ?guest aware? snapshot. 374 "storageLocations": [ # GCS bucket storage location of the auto snapshot (regional or multi-regional). 375 "A String", 376 ], 377 "labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. 378 "a_key": "A String", 379 }, 380 }, 381 "retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy. 382 "onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. 383 "maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept. 384 }, 385 "schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. 386 "weeklySchedule": { # Time window specified for weekly operations. 387 "dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week. 388 { 389 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 390 "day": "A String", # Allows to define schedule that runs specified day of the week. 391 "startTime": "A 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. 392 }, 393 ], 394 }, 395 "hourlySchedule": { # Time window specified for hourly operations. 396 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 397 "hoursInCycle": 42, # Allows to define schedule that runs every nth hour. 398 "startTime": "A 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. 399 }, 400 "dailySchedule": { # Time window specified for daily operations. 401 "duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. 402 "daysInCycle": 42, # Defines a schedule that runs every nth day of the month. 403 "startTime": "A 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. 404 }, 405 }, 406 }, 407 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 408 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 409 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 410 "name": "A 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 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 411 } 412 413 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 414 415For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 416 417The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 418 419Returns: 420 An object of the form: 421 422 { # Represents an Operation resource. 423 # 424 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 425 # 426 # Operations can be global, regional or zonal. 427 # - For global operations, use the globalOperations resource. 428 # - For regional operations, use the regionOperations resource. 429 # - For zonal operations, use the zonalOperations resource. 430 # 431 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 432 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 433 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 434 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 435 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 436 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 437 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 438 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 439 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 440 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 441 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 442 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 443 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 444 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 445 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 446 { 447 "message": "A String", # [Output Only] A human-readable description of the warning code. 448 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 449 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 450 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 451 { 452 "value": "A String", # [Output Only] A warning data value corresponding to the key. 453 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 454 }, 455 ], 456 }, 457 ], 458 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 459 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 460 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 461 "name": "A String", # [Output Only] Name of the resource. 462 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 463 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 464 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 465 { 466 "message": "A String", # [Output Only] An optional, human-readable error message. 467 "code": "A String", # [Output Only] The error type identifier for this error. 468 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 469 }, 470 ], 471 }, 472 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 473 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 474 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 475 }</pre> 476</div> 477 478<div class="method"> 479 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 480 <pre>A list all the resource policies that have been configured for the specified project in specified region. 481 482Args: 483 project: string, Project ID for this request. (required) 484 region: string, Name of the region for this request. (required) 485 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 486 487You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 488 489Currently, only sorting by name or creationTimestamp desc is supported. 490 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 491 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. 492 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 493 494For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 495 496You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 497 498To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 499 500Returns: 501 An object of the form: 502 503 { 504 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 505 "kind": "compute#resourcePolicyList", # [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies 506 "items": [ # [Output Only] A list of ResourcePolicy resources. 507 { 508 "status": "A String", # [Output Only] The status of resource policy creation. 509 "kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies. 510 "description": "A String", 511 "region": "A String", 512 "snapshotSchedulePolicy": { # 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. # Resource policy for persistent disks for creating snapshots. 513 "snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys. 514 "guestFlush": True or False, # Indication to perform a ?guest aware? snapshot. 515 "storageLocations": [ # GCS bucket storage location of the auto snapshot (regional or multi-regional). 516 "A String", 517 ], 518 "labels": { # Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty. 519 "a_key": "A String", 520 }, 521 }, 522 "retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy. 523 "onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. 524 "maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept. 525 }, 526 "schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy. 527 "weeklySchedule": { # Time window specified for weekly operations. 528 "dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week. 529 { 530 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 531 "day": "A String", # Allows to define schedule that runs specified day of the week. 532 "startTime": "A 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. 533 }, 534 ], 535 }, 536 "hourlySchedule": { # Time window specified for hourly operations. 537 "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. 538 "hoursInCycle": 42, # Allows to define schedule that runs every nth hour. 539 "startTime": "A 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. 540 }, 541 "dailySchedule": { # Time window specified for daily operations. 542 "duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. 543 "daysInCycle": 42, # Defines a schedule that runs every nth day of the month. 544 "startTime": "A 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. 545 }, 546 }, 547 }, 548 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 549 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 550 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 551 "name": "A 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 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 552 }, 553 ], 554 "etag": "A String", 555 "warning": { # [Output Only] Informational warning message. 556 "message": "A String", # [Output Only] A human-readable description of the warning code. 557 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 558 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 559 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 560 { 561 "value": "A String", # [Output Only] A warning data value corresponding to the key. 562 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 563 }, 564 ], 565 }, 566 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 567 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 568 }</pre> 569</div> 570 571<div class="method"> 572 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 573 <pre>Retrieves the next page of results. 574 575Args: 576 previous_request: The request for the previous page. (required) 577 previous_response: The response from the request for the previous page. (required) 578 579Returns: 580 A request object that you can call 'execute()' on to request the next 581 page. Returns None if there are no more items in the collection. 582 </pre> 583</div> 584 585<div class="method"> 586 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code> 587 <pre>Returns permissions that a caller has on the specified resource. 588 589Args: 590 project: string, Project ID for this request. (required) 591 region: string, The name of the region for this request. (required) 592 resource: string, Name or id of the resource for this request. (required) 593 body: object, The request body. (required) 594 The object takes the form of: 595 596{ 597 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 598 "A String", 599 ], 600 } 601 602 603Returns: 604 An object of the form: 605 606 { 607 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 608 "A String", 609 ], 610 }</pre> 611</div> 612 613</body></html>