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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetTcpProxies.html">targetTcpProxies</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(project, targetTcpProxy, requestId=None)</a></code></p> 79 <p class="firstline">Deletes the specified TargetTcpProxy resource.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(project, targetTcpProxy)</a></code></p> 82 <p class="firstline">Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 85 <p class="firstline">Creates a TargetTcpProxy resource in the specified project using the data included in the request.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88 <p class="firstline">Retrieves the list of TargetTcpProxy resources available to the specified project.</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="#setBackendService">setBackendService(project, targetTcpProxy, body, requestId=None)</a></code></p> 94 <p class="firstline">Changes the BackendService for TargetTcpProxy.</p> 95 <p class="toc_element"> 96 <code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body, requestId=None)</a></code></p> 97 <p class="firstline">Changes the ProxyHeaderType for TargetTcpProxy.</p> 98 <p class="toc_element"> 99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 100 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 101 <h3>Method Details</h3> 102 <div class="method"> 103 <code class="details" id="delete">delete(project, targetTcpProxy, requestId=None)</code> 104 <pre>Deletes the specified TargetTcpProxy resource. 105 106 Args: 107 project: string, Project ID for this request. (required) 108 targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required) 109 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 110 111 Returns: 112 An object of the form: 113 114 { # An Operation resource, used to manage asynchronous API requests. 115 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 116 "clientOperationId": "A String", # [Output Only] Reserved for future use. 117 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 118 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 119 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 120 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 121 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 122 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 123 "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. 124 "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. 125 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 126 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 127 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 128 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 129 { 130 "message": "A String", # [Output Only] A human-readable description of the warning code. 131 "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. 132 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 133 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 134 { 135 "value": "A String", # [Output Only] A warning data value corresponding to the key. 136 "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). 137 }, 138 ], 139 }, 140 ], 141 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 142 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 143 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 144 "name": "A String", # [Output Only] Name of the resource. 145 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 146 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 147 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 148 { 149 "message": "A String", # [Output Only] An optional, human-readable error message. 150 "code": "A String", # [Output Only] The error type identifier for this error. 151 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 152 }, 153 ], 154 }, 155 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 156 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 157 "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. 158 }</pre> 159 </div> 160 161 <div class="method"> 162 <code class="details" id="get">get(project, targetTcpProxy)</code> 163 <pre>Returns the specified TargetTcpProxy resource. Get a list of available target TCP proxies by making a list() request. 164 165 Args: 166 project: string, Project ID for this request. (required) 167 targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required) 168 169 Returns: 170 An object of the form: 171 172 { # A TargetTcpProxy resource. This resource defines a TCP proxy. 173 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. 174 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 175 "service": "A String", # URL to the BackendService resource. 176 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 177 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 178 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 179 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 180 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 181 }</pre> 182 </div> 183 184 <div class="method"> 185 <code class="details" id="insert">insert(project, body, requestId=None)</code> 186 <pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request. 187 188 Args: 189 project: string, Project ID for this request. (required) 190 body: object, The request body. (required) 191 The object takes the form of: 192 193 { # A TargetTcpProxy resource. This resource defines a TCP proxy. 194 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. 195 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 196 "service": "A String", # URL to the BackendService resource. 197 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 198 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 199 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 201 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 202 } 203 204 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 205 206 Returns: 207 An object of the form: 208 209 { # An Operation resource, used to manage asynchronous API requests. 210 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 211 "clientOperationId": "A String", # [Output Only] Reserved for future use. 212 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 213 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 214 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 215 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 216 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 217 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 218 "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. 219 "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. 220 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 221 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 222 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 223 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 224 { 225 "message": "A String", # [Output Only] A human-readable description of the warning code. 226 "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. 227 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 228 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 229 { 230 "value": "A String", # [Output Only] A warning data value corresponding to the key. 231 "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). 232 }, 233 ], 234 }, 235 ], 236 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 237 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 238 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 239 "name": "A String", # [Output Only] Name of the resource. 240 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 241 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 242 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 243 { 244 "message": "A String", # [Output Only] An optional, human-readable error message. 245 "code": "A String", # [Output Only] The error type identifier for this error. 246 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 247 }, 248 ], 249 }, 250 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 251 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 252 "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. 253 }</pre> 254 </div> 255 256 <div class="method"> 257 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 258 <pre>Retrieves the list of TargetTcpProxy resources available to the specified project. 259 260 Args: 261 project: string, Project ID for this request. (required) 262 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 263 264 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. 265 266 Currently, only sorting by name or creationTimestamp desc is supported. 267 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) 268 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. 269 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. 270 271 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. 272 273 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 274 275 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. 276 277 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. 278 279 Returns: 280 An object of the form: 281 282 { # Contains a list of TargetTcpProxy resources. 283 "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. 284 "items": [ # A list of TargetTcpProxy resources. 285 { # A TargetTcpProxy resource. This resource defines a TCP proxy. 286 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. 287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 288 "service": "A String", # URL to the BackendService resource. 289 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 290 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 291 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 292 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 293 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 294 }, 295 ], 296 "kind": "compute#targetTcpProxyList", # Type of resource. 297 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 298 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 299 }</pre> 300 </div> 301 302 <div class="method"> 303 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 304 <pre>Retrieves the next page of results. 305 306 Args: 307 previous_request: The request for the previous page. (required) 308 previous_response: The response from the request for the previous page. (required) 309 310 Returns: 311 A request object that you can call 'execute()' on to request the next 312 page. Returns None if there are no more items in the collection. 313 </pre> 314 </div> 315 316 <div class="method"> 317 <code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body, requestId=None)</code> 318 <pre>Changes the BackendService for TargetTcpProxy. 319 320 Args: 321 project: string, Project ID for this request. (required) 322 targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required) 323 body: object, The request body. (required) 324 The object takes the form of: 325 326 { 327 "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy. 328 } 329 330 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 331 332 Returns: 333 An object of the form: 334 335 { # An Operation resource, used to manage asynchronous API requests. 336 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 337 "clientOperationId": "A String", # [Output Only] Reserved for future use. 338 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 339 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 340 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 341 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 342 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 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 "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. 345 "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. 346 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 347 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 348 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 349 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 350 { 351 "message": "A String", # [Output Only] A human-readable description of the warning code. 352 "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. 353 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 354 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 355 { 356 "value": "A String", # [Output Only] A warning data value corresponding to the key. 357 "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). 358 }, 359 ], 360 }, 361 ], 362 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 363 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 364 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 365 "name": "A String", # [Output Only] Name of the resource. 366 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 367 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 368 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 369 { 370 "message": "A String", # [Output Only] An optional, human-readable error message. 371 "code": "A String", # [Output Only] The error type identifier for this error. 372 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 373 }, 374 ], 375 }, 376 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 377 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 378 "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. 379 }</pre> 380 </div> 381 382 <div class="method"> 383 <code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body, requestId=None)</code> 384 <pre>Changes the ProxyHeaderType for TargetTcpProxy. 385 386 Args: 387 project: string, Project ID for this request. (required) 388 targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required) 389 body: object, The request body. (required) 390 The object takes the form of: 391 392 { 393 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. 394 } 395 396 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 397 398 Returns: 399 An object of the form: 400 401 { # An Operation resource, used to manage asynchronous API requests. 402 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 403 "clientOperationId": "A String", # [Output Only] Reserved for future use. 404 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 405 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 406 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 407 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 408 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 409 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 410 "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. 411 "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. 412 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 413 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 414 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 415 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 416 { 417 "message": "A String", # [Output Only] A human-readable description of the warning code. 418 "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. 419 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 420 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 421 { 422 "value": "A String", # [Output Only] A warning data value corresponding to the key. 423 "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). 424 }, 425 ], 426 }, 427 ], 428 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 429 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 430 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 431 "name": "A String", # [Output Only] Name of the resource. 432 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 433 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 434 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 435 { 436 "message": "A String", # [Output Only] An optional, human-readable error message. 437 "code": "A String", # [Output Only] The error type identifier for this error. 438 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 439 }, 440 ], 441 }, 442 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 443 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 444 "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. 445 }</pre> 446 </div> 447 448 <div class="method"> 449 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 450 <pre>Returns permissions that a caller has on the specified resource. 451 452 Args: 453 project: string, Project ID for this request. (required) 454 resource: string, Name of the resource for this request. (required) 455 body: object, The request body. (required) 456 The object takes the form of: 457 458 { 459 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 460 "A String", 461 ], 462 } 463 464 465 Returns: 466 An object of the form: 467 468 { 469 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 470 "A String", 471 ], 472 }</pre> 473 </div> 474 475 </body></html>
