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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalOperations.html">globalOperations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Retrieves an aggregated list of all operations.</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="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(project, operation, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified Operations resource.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, operation, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the specified Operations resource.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Retrieves a list of Operation resources contained within the specified project.</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="#wait">wait(project, operation, x__xgafv=None)</a></code></p> 100<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> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 104 <pre>Retrieves an aggregated list of all operations. 105 106Args: 107 project: string, Project ID for this request. (required) 108 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) ``` 109 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. 110 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`) 111 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. 112 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. 113 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { 123 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 124 "items": { # [Output Only] A map of scoped operation lists. 125 "a_key": { # [Output Only] Name of the scope containing this set of operations. 126 "operations": [ # [Output Only] A list of operations contained in this scope. 127 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 128 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 129 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 130 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 131 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 132 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 133 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 134 { 135 "code": "A String", # [Output Only] The error type identifier for this error. 136 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 137 "message": "A String", # [Output Only] An optional, human-readable error message. 138 }, 139 ], 140 }, 141 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 142 "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. 143 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 144 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 145 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 146 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 147 "a_key": "", # Properties of the object. Contains field @type with type URL. 148 }, 149 "name": "A String", # [Output Only] Name of the operation. 150 "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. 151 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 152 "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. 153 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 154 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 155 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 156 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 157 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 158 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 159 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 160 "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. 161 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 162 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 163 { 164 "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. 165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 166 { 167 "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). 168 "value": "A String", # [Output Only] A warning data value corresponding to the key. 169 }, 170 ], 171 "message": "A String", # [Output Only] A human-readable description of the warning code. 172 }, 173 ], 174 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 175 }, 176 ], 177 "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty. 178 "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. 179 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 180 { 181 "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). 182 "value": "A String", # [Output Only] A warning data value corresponding to the key. 183 }, 184 ], 185 "message": "A String", # [Output Only] A human-readable description of the warning code. 186 }, 187 }, 188 }, 189 "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations. 190 "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. 191 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 192 "unreachables": [ # [Output Only] Unreachable resources. 193 "A String", 194 ], 195 "warning": { # [Output Only] Informational warning message. 196 "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. 197 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 198 { 199 "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). 200 "value": "A String", # [Output Only] A warning data value corresponding to the key. 201 }, 202 ], 203 "message": "A String", # [Output Only] A human-readable description of the warning code. 204 }, 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 210 <pre>Retrieves the next page of results. 211 212Args: 213 previous_request: The request for the previous page. (required) 214 previous_response: The response from the request for the previous page. (required) 215 216Returns: 217 A request object that you can call 'execute()' on to request the next 218 page. Returns None if there are no more items in the collection. 219 </pre> 220</div> 221 222<div class="method"> 223 <code class="details" id="close">close()</code> 224 <pre>Close httplib2 connections.</pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="delete">delete(project, operation, x__xgafv=None)</code> 229 <pre>Deletes the specified Operations resource. 230 231Args: 232 project: string, Project ID for this request. (required) 233 operation: string, Name of the Operations resource to delete. (required) 234 x__xgafv: string, V1 error format. 235 Allowed values 236 1 - v1 error format 237 2 - v2 error format 238</pre> 239</div> 240 241<div class="method"> 242 <code class="details" id="get">get(project, operation, x__xgafv=None)</code> 243 <pre>Retrieves the specified Operations resource. 244 245Args: 246 project: string, Project ID for this request. (required) 247 operation: string, Name of the Operations resource to return. (required) 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 257 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 258 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 259 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 260 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 261 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 262 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 263 { 264 "code": "A String", # [Output Only] The error type identifier for this error. 265 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 266 "message": "A String", # [Output Only] An optional, human-readable error message. 267 }, 268 ], 269 }, 270 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 271 "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. 272 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 273 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 274 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 275 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 276 "a_key": "", # Properties of the object. Contains field @type with type URL. 277 }, 278 "name": "A String", # [Output Only] Name of the operation. 279 "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. 280 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 281 "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. 282 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 283 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 284 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 285 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 286 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 287 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 288 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 289 "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. 290 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 291 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 292 { 293 "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. 294 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 295 { 296 "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). 297 "value": "A String", # [Output Only] A warning data value corresponding to the key. 298 }, 299 ], 300 "message": "A String", # [Output Only] A human-readable description of the warning code. 301 }, 302 ], 303 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 304}</pre> 305</div> 306 307<div class="method"> 308 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 309 <pre>Retrieves a list of Operation resources contained within the specified project. 310 311Args: 312 project: string, Project ID for this request. (required) 313 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) ``` 314 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`) 315 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. 316 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. 317 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 318 x__xgafv: string, V1 error format. 319 Allowed values 320 1 - v1 error format 321 2 - v2 error format 322 323Returns: 324 An object of the form: 325 326 { # Contains a list of Operation resources. 327 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 328 "items": [ # [Output Only] A list of Operation resources. 329 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 330 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 331 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 332 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 333 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 334 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 335 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 336 { 337 "code": "A String", # [Output Only] The error type identifier for this error. 338 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 339 "message": "A String", # [Output Only] An optional, human-readable error message. 340 }, 341 ], 342 }, 343 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 344 "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. 345 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 346 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 347 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 348 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 349 "a_key": "", # Properties of the object. Contains field @type with type URL. 350 }, 351 "name": "A String", # [Output Only] Name of the operation. 352 "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. 353 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 354 "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. 355 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 356 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 357 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 358 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 359 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 360 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 361 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 362 "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. 363 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 364 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 365 { 366 "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. 367 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 368 { 369 "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). 370 "value": "A String", # [Output Only] A warning data value corresponding to the key. 371 }, 372 ], 373 "message": "A String", # [Output Only] A human-readable description of the warning code. 374 }, 375 ], 376 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 377 }, 378 ], 379 "kind": "compute#operationList", # [Output Only] Type of resource. Always `compute#operations` for Operations resource. 380 "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. 381 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 382 "warning": { # [Output Only] Informational warning message. 383 "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. 384 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 385 { 386 "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). 387 "value": "A String", # [Output Only] A warning data value corresponding to the key. 388 }, 389 ], 390 "message": "A String", # [Output Only] A human-readable description of the warning code. 391 }, 392}</pre> 393</div> 394 395<div class="method"> 396 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 397 <pre>Retrieves the next page of results. 398 399Args: 400 previous_request: The request for the previous page. (required) 401 previous_response: The response from the request for the previous page. (required) 402 403Returns: 404 A request object that you can call 'execute()' on to request the next 405 page. Returns None if there are no more items in the collection. 406 </pre> 407</div> 408 409<div class="method"> 410 <code class="details" id="wait">wait(project, operation, x__xgafv=None)</code> 411 <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`. 412 413Args: 414 project: string, Project ID for this request. (required) 415 operation: string, Name of the Operations resource to return. (required) 416 x__xgafv: string, V1 error format. 417 Allowed values 418 1 - v1 error format 419 2 - v2 error format 420 421Returns: 422 An object of the form: 423 424 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 425 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 426 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 427 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 428 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 429 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 430 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 431 { 432 "code": "A String", # [Output Only] The error type identifier for this error. 433 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 434 "message": "A String", # [Output Only] An optional, human-readable error message. 435 }, 436 ], 437 }, 438 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 439 "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. 440 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 441 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 442 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 443 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 444 "a_key": "", # Properties of the object. Contains field @type with type URL. 445 }, 446 "name": "A String", # [Output Only] Name of the operation. 447 "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. 448 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 449 "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. 450 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 451 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 452 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 453 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 454 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 455 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 456 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 457 "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. 458 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 459 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 460 { 461 "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. 462 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 463 { 464 "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). 465 "value": "A String", # [Output Only] A warning data value corresponding to the key. 466 }, 467 ], 468 "message": "A String", # [Output Only] A human-readable description of the warning code. 469 }, 470 ], 471 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 472}</pre> 473</div> 474 475</body></html>