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_v1.html">Compute Engine API</a> . <a href="compute_v1.regionOperations.html">regionOperations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, region, operation, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified region-specific Operations resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, region, operation, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves the specified region-specific Operations resource.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of Operation resources contained within the specified region.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#wait">wait(project, region, operation, x__xgafv=None)</a></code></p> 94<p class="firstline">Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. </p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="delete">delete(project, region, operation, x__xgafv=None)</code> 103 <pre>Deletes the specified region-specific Operations resource. 104 105Args: 106 project: string, Project ID for this request. (required) 107 region: string, Name of the region for this request. (required) 108 operation: string, Name of the Operations resource to delete. (required) 109 x__xgafv: string, V1 error format. 110 Allowed values 111 1 - v1 error format 112 2 - v2 error format 113</pre> 114</div> 115 116<div class="method"> 117 <code class="details" id="get">get(project, region, operation, x__xgafv=None)</code> 118 <pre>Retrieves the specified region-specific Operations resource. 119 120Args: 121 project: string, Project ID for this request. (required) 122 region: string, Name of the region for this request. (required) 123 operation: string, Name of the Operations resource to return. (required) 124 x__xgafv: string, V1 error format. 125 Allowed values 126 1 - v1 error format 127 2 - v2 error format 128 129Returns: 130 An object of the form: 131 132 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 133 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 134 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 135 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 136 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 137 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 138 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 139 { 140 "code": "A String", # [Output Only] The error type identifier for this error. 141 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 142 "message": "A String", # [Output Only] An optional, human-readable error message. 143 }, 144 ], 145 }, 146 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 147 "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. 148 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 149 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 150 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 151 "name": "A String", # [Output Only] Name of the operation. 152 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 153 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 154 "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. 155 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 156 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 157 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 158 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 159 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 160 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 161 "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. 162 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 163 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 164 { 165 "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. 166 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 167 { 168 "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). 169 "value": "A String", # [Output Only] A warning data value corresponding to the key. 170 }, 171 ], 172 "message": "A String", # [Output Only] A human-readable description of the warning code. 173 }, 174 ], 175 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 181 <pre>Retrieves a list of Operation resources contained within the specified region. 182 183Args: 184 project: string, Project ID for this request. (required) 185 region: string, Name of the region for this request. (required) 186 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 187 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`) 188 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 189 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. 190 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # Contains a list of Operation resources. 200 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 201 "items": [ # [Output Only] A list of Operation resources. 202 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 203 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 204 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 205 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 206 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 207 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 208 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 209 { 210 "code": "A String", # [Output Only] The error type identifier for this error. 211 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 212 "message": "A String", # [Output Only] An optional, human-readable error message. 213 }, 214 ], 215 }, 216 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 217 "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. 218 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 219 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 220 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 221 "name": "A String", # [Output Only] Name of the operation. 222 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 223 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 224 "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. 225 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 226 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 227 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 228 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 229 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 230 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 231 "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. 232 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 233 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 234 { 235 "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. 236 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 237 { 238 "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). 239 "value": "A String", # [Output Only] A warning data value corresponding to the key. 240 }, 241 ], 242 "message": "A String", # [Output Only] A human-readable description of the warning code. 243 }, 244 ], 245 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 246 }, 247 ], 248 "kind": "compute#operationList", # [Output Only] Type of resource. Always `compute#operations` for Operations resource. 249 "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. 250 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 251 "warning": { # [Output Only] Informational warning message. 252 "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. 253 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 254 { 255 "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). 256 "value": "A String", # [Output Only] A warning data value corresponding to the key. 257 }, 258 ], 259 "message": "A String", # [Output Only] A human-readable description of the warning code. 260 }, 261}</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 266 <pre>Retrieves the next page of results. 267 268Args: 269 previous_request: The request for the previous page. (required) 270 previous_response: The response from the request for the previous page. (required) 271 272Returns: 273 A request object that you can call 'execute()' on to request the next 274 page. Returns None if there are no more items in the collection. 275 </pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="wait">wait(project, region, operation, x__xgafv=None)</code> 280 <pre>Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. 281 282Args: 283 project: string, Project ID for this request. (required) 284 region: string, Name of the region for this request. (required) 285 operation: string, Name of the Operations resource to return. (required) 286 x__xgafv: string, V1 error format. 287 Allowed values 288 1 - v1 error format 289 2 - v2 error format 290 291Returns: 292 An object of the form: 293 294 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 295 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 296 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 297 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 298 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 299 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 300 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 301 { 302 "code": "A String", # [Output Only] The error type identifier for this error. 303 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 304 "message": "A String", # [Output Only] An optional, human-readable error message. 305 }, 306 ], 307 }, 308 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 309 "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. 310 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 311 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 312 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 313 "name": "A String", # [Output Only] Name of the operation. 314 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 315 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 316 "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. 317 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 318 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 319 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 320 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 321 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 322 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 323 "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. 324 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 325 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 326 { 327 "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. 328 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 329 { 330 "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). 331 "value": "A String", # [Output Only] A warning data value corresponding to the key. 332 }, 333 ], 334 "message": "A String", # [Output Only] A human-readable description of the warning code. 335 }, 336 ], 337 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 338}</pre> 339</div> 340 341</body></html>