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