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="clouduseraccounts_vm_beta.html">Cloud User Accounts API</a> . <a href="clouduseraccounts_vm_beta.globalAccountsOperations.html">globalAccountsOperations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(project, operation)</a></code></p> 79<p class="firstline">Deletes the specified operation resource.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(project, operation)</a></code></p> 82<p class="firstline">Retrieves the specified operation resource.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 85<p class="firstline">Retrieves the list of operation resources contained within the specified project.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="delete">delete(project, operation)</code> 92 <pre>Deletes the specified operation resource. 93 94Args: 95 project: string, Project ID for this request. (required) 96 operation: string, Name of the Operations resource to delete. (required) 97</pre> 98</div> 99 100<div class="method"> 101 <code class="details" id="get">get(project, operation)</code> 102 <pre>Retrieves the specified operation resource. 103 104Args: 105 project: string, Project ID for this request. (required) 106 operation: string, Name of the Operations resource to return. (required) 107 108Returns: 109 An object of the form: 110 111 { # An Operation resource, used to manage asynchronous API requests. 112 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 113 "clientOperationId": "A String", # [Output Only] Reserved for future use. 114 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 115 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 116 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 117 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 118 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 119 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 120 "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. 121 "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. 122 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 123 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 124 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 125 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 126 { 127 "message": "A String", # [Output Only] A human-readable description of the warning code. 128 "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. 129 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 130 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 131 { 132 "value": "A String", # [Output Only] A warning data value corresponding to the key. 133 "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). 134 }, 135 ], 136 }, 137 ], 138 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 139 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 140 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 141 "name": "A String", # [Output Only] Name of the resource. 142 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 143 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 144 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 145 { 146 "message": "A String", # [Output Only] An optional, human-readable error message. 147 "code": "A String", # [Output Only] The error type identifier for this error. 148 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 149 }, 150 ], 151 }, 152 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 154 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 155 }</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 160 <pre>Retrieves the list of operation resources contained within the specified project. 161 162Args: 163 project: string, Project ID for this request. (required) 164 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 165 166You 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. 167 168Currently, only sorting by name or creationTimestamp desc is supported. 169 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. 170 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. 171 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. 172 173The 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. 174 175For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 176 177Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. 178 179The Beta API also supports filtering on multiple expressions by providing 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. 180 181Returns: 182 An object of the form: 183 184 { # Contains a list of Operation resources. 185 "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. 186 "items": [ # [Output Only] A list of Operation resources. 187 { # An Operation resource, used to manage asynchronous API requests. 188 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 189 "clientOperationId": "A String", # [Output Only] Reserved for future use. 190 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 191 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 192 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 194 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 195 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 196 "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. 197 "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. 198 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 199 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 200 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 201 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 202 { 203 "message": "A String", # [Output Only] A human-readable description of the warning code. 204 "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. 205 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 206 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 207 { 208 "value": "A String", # [Output Only] A warning data value corresponding to the key. 209 "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). 210 }, 211 ], 212 }, 213 ], 214 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 215 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 216 "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 217 "name": "A String", # [Output Only] Name of the resource. 218 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 219 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 220 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 221 { 222 "message": "A String", # [Output Only] An optional, human-readable error message. 223 "code": "A String", # [Output Only] The error type identifier for this error. 224 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 225 }, 226 ], 227 }, 228 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 229 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 230 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. 231 }, 232 ], 233 "kind": "clouduseraccounts#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource. 234 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 235 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 236 }</pre> 237</div> 238 239<div class="method"> 240 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 241 <pre>Retrieves the next page of results. 242 243Args: 244 previous_request: The request for the previous page. (required) 245 previous_response: The response from the request for the previous page. (required) 246 247Returns: 248 A request object that you can call 'execute()' on to request the next 249 page. Returns None if there are no more items in the collection. 250 </pre> 251</div> 252 253</body></html>