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.targetTcpProxies.html">targetTcpProxies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, targetTcpProxy, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified TargetTcpProxy resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, targetTcpProxy, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a TargetTcpProxy resource in the specified project using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the list of TargetTcpProxy resources available to 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<p class="toc_element"> 96 <code><a href="#setBackendService">setBackendService(project, targetTcpProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Changes the BackendService for TargetTcpProxy.</p> 98<p class="toc_element"> 99 <code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Changes the ProxyHeaderType for TargetTcpProxy.</p> 101<p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="delete">delete(project, targetTcpProxy, requestId=None, x__xgafv=None)</code> 112 <pre>Deletes the specified TargetTcpProxy resource. 113 114Args: 115 project: string, Project ID for this request. (required) 116 targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required) 117 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # 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. 127 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 128 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 129 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 130 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 131 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 132 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 133 { 134 "code": "A String", # [Output Only] The error type identifier for this error. 135 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 136 "message": "A String", # [Output Only] An optional, human-readable error message. 137 }, 138 ], 139 }, 140 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 141 "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. 142 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 143 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 144 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 145 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 "name": "A String", # [Output Only] Name of the operation. 149 "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. 150 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 151 "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. 152 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 154 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 155 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 156 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 157 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 158 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 159 "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. 160 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 162 { 163 "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. 164 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 165 { 166 "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). 167 "value": "A String", # [Output Only] A warning data value corresponding to the key. 168 }, 169 ], 170 "message": "A String", # [Output Only] A human-readable description of the warning code. 171 }, 172 ], 173 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="get">get(project, targetTcpProxy, x__xgafv=None)</code> 179 <pre>Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. 180 181Args: 182 project: string, Project ID for this request. (required) 183 targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required) 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. 193 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 194 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 195 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 196 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. 197 "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. 198 "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. 199 "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. 200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 201 "service": "A String", # URL to the BackendService resource. 202}</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 207 <pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request. 208 209Args: 210 project: string, Project ID for this request. (required) 211 body: object, The request body. 212 The object takes the form of: 213 214{ # Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. 215 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 216 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 217 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 218 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. 219 "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. 220 "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. 221 "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. 222 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 223 "service": "A String", # URL to the BackendService resource. 224} 225 226 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 227 x__xgafv: string, V1 error format. 228 Allowed values 229 1 - v1 error format 230 2 - v2 error format 231 232Returns: 233 An object of the form: 234 235 { # 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. 236 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 237 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 238 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 239 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 240 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 241 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 242 { 243 "code": "A String", # [Output Only] The error type identifier for this error. 244 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 245 "message": "A String", # [Output Only] An optional, human-readable error message. 246 }, 247 ], 248 }, 249 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 250 "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. 251 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 252 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 253 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 254 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 255 "a_key": "", # Properties of the object. Contains field @type with type URL. 256 }, 257 "name": "A String", # [Output Only] Name of the operation. 258 "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. 259 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 260 "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. 261 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 262 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 263 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 264 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 265 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 266 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 267 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 268 "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. 269 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 270 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 271 { 272 "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. 273 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 274 { 275 "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). 276 "value": "A String", # [Output Only] A warning data value corresponding to the key. 277 }, 278 ], 279 "message": "A String", # [Output Only] A human-readable description of the warning code. 280 }, 281 ], 282 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 283}</pre> 284</div> 285 286<div class="method"> 287 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 288 <pre>Retrieves the list of TargetTcpProxy resources available to the specified project. 289 290Args: 291 project: string, Project ID for this request. (required) 292 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) ``` 293 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`) 294 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. 295 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. 296 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 297 x__xgafv: string, V1 error format. 298 Allowed values 299 1 - v1 error format 300 2 - v2 error format 301 302Returns: 303 An object of the form: 304 305 { # Contains a list of TargetTcpProxy resources. 306 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 307 "items": [ # A list of TargetTcpProxy resources. 308 { # Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. 309 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 310 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 311 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 312 "kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. 313 "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. 314 "proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. 315 "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. 316 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 317 "service": "A String", # URL to the BackendService resource. 318 }, 319 ], 320 "kind": "compute#targetTcpProxyList", # Type of resource. 321 "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. 322 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 323 "warning": { # [Output Only] Informational warning message. 324 "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. 325 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 326 { 327 "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). 328 "value": "A String", # [Output Only] A warning data value corresponding to the key. 329 }, 330 ], 331 "message": "A String", # [Output Only] A human-readable description of the warning code. 332 }, 333}</pre> 334</div> 335 336<div class="method"> 337 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 338 <pre>Retrieves the next page of results. 339 340Args: 341 previous_request: The request for the previous page. (required) 342 previous_response: The response from the request for the previous page. (required) 343 344Returns: 345 A request object that you can call 'execute()' on to request the next 346 page. Returns None if there are no more items in the collection. 347 </pre> 348</div> 349 350<div class="method"> 351 <code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body=None, requestId=None, x__xgafv=None)</code> 352 <pre>Changes the BackendService for TargetTcpProxy. 353 354Args: 355 project: string, Project ID for this request. (required) 356 targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required) 357 body: object, The request body. 358 The object takes the form of: 359 360{ 361 "service": "A String", # The URL of the new BackendService resource for the targetTcpProxy. 362} 363 364 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 365 x__xgafv: string, V1 error format. 366 Allowed values 367 1 - v1 error format 368 2 - v2 error format 369 370Returns: 371 An object of the form: 372 373 { # 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. 374 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 375 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 376 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 377 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 378 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 379 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 380 { 381 "code": "A String", # [Output Only] The error type identifier for this error. 382 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 383 "message": "A String", # [Output Only] An optional, human-readable error message. 384 }, 385 ], 386 }, 387 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 388 "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. 389 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 390 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 391 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 392 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 393 "a_key": "", # Properties of the object. Contains field @type with type URL. 394 }, 395 "name": "A String", # [Output Only] Name of the operation. 396 "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. 397 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 398 "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. 399 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 400 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 401 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 402 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 403 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 404 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 405 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 406 "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. 407 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 408 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 409 { 410 "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. 411 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 412 { 413 "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). 414 "value": "A String", # [Output Only] A warning data value corresponding to the key. 415 }, 416 ], 417 "message": "A String", # [Output Only] A human-readable description of the warning code. 418 }, 419 ], 420 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 421}</pre> 422</div> 423 424<div class="method"> 425 <code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body=None, requestId=None, x__xgafv=None)</code> 426 <pre>Changes the ProxyHeaderType for TargetTcpProxy. 427 428Args: 429 project: string, Project ID for this request. (required) 430 targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required) 431 body: object, The request body. 432 The object takes the form of: 433 434{ 435 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. 436} 437 438 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 439 x__xgafv: string, V1 error format. 440 Allowed values 441 1 - v1 error format 442 2 - v2 error format 443 444Returns: 445 An object of the form: 446 447 { # 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. 448 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 449 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 450 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 451 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 452 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 453 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 454 { 455 "code": "A String", # [Output Only] The error type identifier for this error. 456 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 457 "message": "A String", # [Output Only] An optional, human-readable error message. 458 }, 459 ], 460 }, 461 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 462 "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. 463 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 464 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 465 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 466 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 467 "a_key": "", # Properties of the object. Contains field @type with type URL. 468 }, 469 "name": "A String", # [Output Only] Name of the operation. 470 "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. 471 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 472 "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. 473 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 474 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 475 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 476 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 477 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 478 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 479 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 480 "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. 481 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 482 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 483 { 484 "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. 485 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 486 { 487 "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). 488 "value": "A String", # [Output Only] A warning data value corresponding to the key. 489 }, 490 ], 491 "message": "A String", # [Output Only] A human-readable description of the warning code. 492 }, 493 ], 494 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 495}</pre> 496</div> 497 498<div class="method"> 499 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 500 <pre>Returns permissions that a caller has on the specified resource. 501 502Args: 503 project: string, Project ID for this request. (required) 504 resource: string, Name or id of the resource for this request. (required) 505 body: object, The request body. 506 The object takes the form of: 507 508{ 509 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 510 "A String", 511 ], 512} 513 514 x__xgafv: string, V1 error format. 515 Allowed values 516 1 - v1 error format 517 2 - v2 error format 518 519Returns: 520 An object of the form: 521 522 { 523 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 524 "A String", 525 ], 526}</pre> 527</div> 528 529</body></html>