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