1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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.globalOperations.html">globalOperations</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 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="#delete">delete(project, operation)</a></code></p> 85 <p class="firstline">Deletes the specified Operations resource.</p> 86 <p class="toc_element"> 87 <code><a href="#get">get(project, operation)</a></code></p> 88 <p class="firstline">Retrieves the specified Operations resource. Get a list of operations by making a list() request.</p> 89 <p class="toc_element"> 90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 91 <p class="firstline">Retrieves a list of Operation resources contained within the specified project.</p> 92 <p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94 <p class="firstline">Retrieves the next page of results.</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 98 <pre>Retrieves an aggregated list of all operations. 99 100 Args: 101 project: string, Project ID for this request. (required) 102 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 103 104 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. 105 106 Currently, only sorting by name or creationTimestamp desc is supported. 107 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) 108 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. 109 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 110 111 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 112 113 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 114 115 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 116 117 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 118 119 Returns: 120 An object of the form: 121 122 { 123 "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. 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] List of operations contained in this scope. 127 { # An Operation resource, used to manage asynchronous API requests. 128 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 129 "clientOperationId": "A String", # [Output Only] Reserved for future use. 130 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 131 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 132 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 133 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 134 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 135 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 136 "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. 137 "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. 138 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 139 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 140 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 141 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 142 { 143 "message": "A String", # [Output Only] A human-readable description of the warning code. 144 "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. 145 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 146 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 147 { 148 "value": "A String", # [Output Only] A warning data value corresponding to the key. 149 "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). 150 }, 151 ], 152 }, 153 ], 154 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 155 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 156 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 157 "name": "A String", # [Output Only] Name of the resource. 158 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 159 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 160 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 161 { 162 "message": "A String", # [Output Only] An optional, human-readable error message. 163 "code": "A String", # [Output Only] The error type identifier for this error. 164 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 165 }, 166 ], 167 }, 168 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 169 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 170 "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. 171 }, 172 ], 173 "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty. 174 "message": "A String", # [Output Only] A human-readable description of the warning code. 175 "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. 176 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 177 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 178 { 179 "value": "A String", # [Output Only] A warning data value corresponding to the key. 180 "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). 181 }, 182 ], 183 }, 184 }, 185 }, 186 "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. 187 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 188 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 189 }</pre> 190 </div> 191 192 <div class="method"> 193 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 194 <pre>Retrieves the next page of results. 195 196 Args: 197 previous_request: The request for the previous page. (required) 198 previous_response: The response from the request for the previous page. (required) 199 200 Returns: 201 A request object that you can call 'execute()' on to request the next 202 page. Returns None if there are no more items in the collection. 203 </pre> 204 </div> 205 206 <div class="method"> 207 <code class="details" id="delete">delete(project, operation)</code> 208 <pre>Deletes the specified Operations resource. 209 210 Args: 211 project: string, Project ID for this request. (required) 212 operation: string, Name of the Operations resource to delete. (required) 213 </pre> 214 </div> 215 216 <div class="method"> 217 <code class="details" id="get">get(project, operation)</code> 218 <pre>Retrieves the specified Operations resource. Get a list of operations by making a list() request. 219 220 Args: 221 project: string, Project ID for this request. (required) 222 operation: string, Name of the Operations resource to return. (required) 223 224 Returns: 225 An object of the form: 226 227 { # An Operation resource, used to manage asynchronous API requests. 228 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 229 "clientOperationId": "A String", # [Output Only] Reserved for future use. 230 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 231 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 232 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 233 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 234 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 235 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 236 "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. 237 "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. 238 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 239 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 240 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 241 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 242 { 243 "message": "A String", # [Output Only] A human-readable description of the warning code. 244 "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. 245 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 246 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 247 { 248 "value": "A String", # [Output Only] A warning data value corresponding to the key. 249 "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). 250 }, 251 ], 252 }, 253 ], 254 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 255 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 256 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 257 "name": "A String", # [Output Only] Name of the resource. 258 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 259 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 260 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 261 { 262 "message": "A String", # [Output Only] An optional, human-readable error message. 263 "code": "A String", # [Output Only] The error type identifier for this error. 264 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 265 }, 266 ], 267 }, 268 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 269 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 270 "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. 271 }</pre> 272 </div> 273 274 <div class="method"> 275 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 276 <pre>Retrieves a list of Operation resources contained within the specified project. 277 278 Args: 279 project: string, Project ID for this request. (required) 280 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 281 282 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. 283 284 Currently, only sorting by name or creationTimestamp desc is supported. 285 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) 286 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. 287 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 288 289 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 290 291 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 292 293 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 294 295 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 296 297 Returns: 298 An object of the form: 299 300 { # Contains a list of Operation resources. 301 "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. 302 "items": [ # [Output Only] A list of Operation resources. 303 { # An Operation resource, used to manage asynchronous API requests. 304 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 305 "clientOperationId": "A String", # [Output Only] Reserved for future use. 306 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 307 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 308 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 309 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 310 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 311 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 312 "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. 313 "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. 314 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 315 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 316 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 317 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 318 { 319 "message": "A String", # [Output Only] A human-readable description of the warning code. 320 "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. 321 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 322 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 323 { 324 "value": "A String", # [Output Only] A warning data value corresponding to the key. 325 "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). 326 }, 327 ], 328 }, 329 ], 330 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 331 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 332 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 333 "name": "A String", # [Output Only] Name of the resource. 334 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 335 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 336 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 337 { 338 "message": "A String", # [Output Only] An optional, human-readable error message. 339 "code": "A String", # [Output Only] The error type identifier for this error. 340 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 341 }, 342 ], 343 }, 344 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 345 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 346 "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. 347 }, 348 ], 349 "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource. 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 URL for this resource. 352 }</pre> 353 </div> 354 355 <div class="method"> 356 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 357 <pre>Retrieves the next page of results. 358 359 Args: 360 previous_request: The request for the previous page. (required) 361 previous_response: The response from the request for the previous page. (required) 362 363 Returns: 364 A request object that you can call 'execute()' on to request the next 365 page. Returns None if there are no more items in the collection. 366 </pre> 367 </div> 368 369 </body></html>
