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.targetHttpProxies.html">targetHttpProxies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(project, targetHttpProxy, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified TargetHttpProxy resource.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, targetHttpProxy, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Creates a TargetHttpProxy resource in the specified project using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(project, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.</p> 104<p class="toc_element"> 105 <code><a href="#setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Changes the URL map for TargetHttpProxy.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 110 <pre>Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. 111 112Args: 113 project: string, Name of the project scoping this request. (required) 114 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) ``` 115 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. 116 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`) 117 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. 118 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. 119 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124 125Returns: 126 An object of the form: 127 128 { 129 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 130 "items": { # A list of TargetHttpProxiesScopedList resources. 131 "a_key": { # Name of the scope containing this set of TargetHttpProxies. 132 "targetHttpProxies": [ # A list of TargetHttpProxies contained in this scope. 133 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 134 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 135 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 136 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. 137 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 138 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 139 "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. 140 "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. 141 "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. 142 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 143 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 144 }, 145 ], 146 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 147 "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. 148 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 149 { 150 "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). 151 "value": "A String", # [Output Only] A warning data value corresponding to the key. 152 }, 153 ], 154 "message": "A String", # [Output Only] A human-readable description of the warning code. 155 }, 156 }, 157 }, 158 "kind": "compute#targetHttpProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. 159 "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. 160 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 161 "unreachables": [ # [Output Only] Unreachable resources. 162 "A String", 163 ], 164}</pre> 165</div> 166 167<div class="method"> 168 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 169 <pre>Retrieves the next page of results. 170 171Args: 172 previous_request: The request for the previous page. (required) 173 previous_response: The response from the request for the previous page. (required) 174 175Returns: 176 A request object that you can call 'execute()' on to request the next 177 page. Returns None if there are no more items in the collection. 178 </pre> 179</div> 180 181<div class="method"> 182 <code class="details" id="close">close()</code> 183 <pre>Close httplib2 connections.</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="delete">delete(project, targetHttpProxy, requestId=None, x__xgafv=None)</code> 188 <pre>Deletes the specified TargetHttpProxy resource. 189 190Args: 191 project: string, Project ID for this request. (required) 192 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required) 193 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). 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198 199Returns: 200 An object of the form: 201 202 { # 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. 203 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 204 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 205 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 206 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 207 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 208 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 209 { 210 "code": "A String", # [Output Only] The error type identifier for this error. 211 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 212 "message": "A String", # [Output Only] An optional, human-readable error message. 213 }, 214 ], 215 }, 216 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 217 "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. 218 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 219 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 220 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 221 "name": "A String", # [Output Only] Name of the operation. 222 "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. 223 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 224 "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. 225 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 226 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 227 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 228 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 229 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 230 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 231 "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. 232 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 233 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 234 { 235 "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. 236 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 237 { 238 "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). 239 "value": "A String", # [Output Only] A warning data value corresponding to the key. 240 }, 241 ], 242 "message": "A String", # [Output Only] A human-readable description of the warning code. 243 }, 244 ], 245 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 246}</pre> 247</div> 248 249<div class="method"> 250 <code class="details" id="get">get(project, targetHttpProxy, x__xgafv=None)</code> 251 <pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. 252 253Args: 254 project: string, Project ID for this request. (required) 255 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required) 256 x__xgafv: string, V1 error format. 257 Allowed values 258 1 - v1 error format 259 2 - v2 error format 260 261Returns: 262 An object of the form: 263 264 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 265 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 266 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 267 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. 268 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 269 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 270 "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. 271 "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. 272 "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. 273 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 274 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 275}</pre> 276</div> 277 278<div class="method"> 279 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 280 <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request. 281 282Args: 283 project: string, Project ID for this request. (required) 284 body: object, The request body. 285 The object takes the form of: 286 287{ # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 288 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 289 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 290 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. 291 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 292 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 293 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 294 "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. 295 "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. 296 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 297 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 298} 299 300 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). 301 x__xgafv: string, V1 error format. 302 Allowed values 303 1 - v1 error format 304 2 - v2 error format 305 306Returns: 307 An object of the form: 308 309 { # 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. 310 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 311 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 312 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 313 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 314 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 315 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 316 { 317 "code": "A String", # [Output Only] The error type identifier for this error. 318 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 319 "message": "A String", # [Output Only] An optional, human-readable error message. 320 }, 321 ], 322 }, 323 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 324 "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. 325 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 326 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 327 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 328 "name": "A String", # [Output Only] Name of the operation. 329 "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. 330 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 331 "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. 332 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 333 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 334 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 335 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 336 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 337 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 338 "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. 339 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 340 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 341 { 342 "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. 343 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 344 { 345 "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). 346 "value": "A String", # [Output Only] A warning data value corresponding to the key. 347 }, 348 ], 349 "message": "A String", # [Output Only] A human-readable description of the warning code. 350 }, 351 ], 352 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 353}</pre> 354</div> 355 356<div class="method"> 357 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 358 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project. 359 360Args: 361 project: string, Project ID for this request. (required) 362 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) ``` 363 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`) 364 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. 365 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. 366 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 367 x__xgafv: string, V1 error format. 368 Allowed values 369 1 - v1 error format 370 2 - v2 error format 371 372Returns: 373 An object of the form: 374 375 { # A list of TargetHttpProxy resources. 376 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 377 "items": [ # A list of TargetHttpProxy resources. 378 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 379 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 380 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 381 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. 382 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 383 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 384 "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. 385 "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. 386 "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. 387 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 388 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 389 }, 390 ], 391 "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. 392 "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. 393 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 394 "warning": { # [Output Only] Informational warning message. 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}</pre> 405</div> 406 407<div class="method"> 408 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 409 <pre>Retrieves the next page of results. 410 411Args: 412 previous_request: The request for the previous page. (required) 413 previous_response: The response from the request for the previous page. (required) 414 415Returns: 416 A request object that you can call 'execute()' on to request the next 417 page. Returns None if there are no more items in the collection. 418 </pre> 419</div> 420 421<div class="method"> 422 <code class="details" id="patch">patch(project, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</code> 423 <pre>Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. 424 425Args: 426 project: string, Project ID for this request. (required) 427 targetHttpProxy: string, Name of the TargetHttpProxy resource to patch. (required) 428 body: object, The request body. 429 The object takes the form of: 430 431{ # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 432 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 433 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 434 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. 435 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 436 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 437 "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. 438 "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. 439 "region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. 440 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 441 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 442} 443 444 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). 445 x__xgafv: string, V1 error format. 446 Allowed values 447 1 - v1 error format 448 2 - v2 error format 449 450Returns: 451 An object of the form: 452 453 { # 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. 454 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 455 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 456 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 457 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 458 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 459 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 460 { 461 "code": "A String", # [Output Only] The error type identifier for this error. 462 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 463 "message": "A String", # [Output Only] An optional, human-readable error message. 464 }, 465 ], 466 }, 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 "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. 469 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 470 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 471 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 472 "name": "A String", # [Output Only] Name of the operation. 473 "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. 474 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 475 "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. 476 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 477 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 478 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 479 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 480 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 481 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 482 "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. 483 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 484 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 485 { 486 "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. 487 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 488 { 489 "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). 490 "value": "A String", # [Output Only] A warning data value corresponding to the key. 491 }, 492 ], 493 "message": "A String", # [Output Only] A human-readable description of the warning code. 494 }, 495 ], 496 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 497}</pre> 498</div> 499 500<div class="method"> 501 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</code> 502 <pre>Changes the URL map for TargetHttpProxy. 503 504Args: 505 project: string, Project ID for this request. (required) 506 targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required) 507 body: object, The request body. 508 The object takes the form of: 509 510{ 511 "urlMap": "A String", 512} 513 514 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). 515 x__xgafv: string, V1 error format. 516 Allowed values 517 1 - v1 error format 518 2 - v2 error format 519 520Returns: 521 An object of the form: 522 523 { # 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. 524 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 525 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 526 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 527 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 528 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 529 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 530 { 531 "code": "A String", # [Output Only] The error type identifier for this error. 532 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 533 "message": "A String", # [Output Only] An optional, human-readable error message. 534 }, 535 ], 536 }, 537 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 538 "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. 539 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 540 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 541 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 542 "name": "A String", # [Output Only] Name of the operation. 543 "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. 544 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 545 "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. 546 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 547 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 548 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 549 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 550 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 551 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 552 "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. 553 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 554 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 555 { 556 "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. 557 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 558 { 559 "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). 560 "value": "A String", # [Output Only] A warning data value corresponding to the key. 561 }, 562 ], 563 "message": "A String", # [Output Only] A human-readable description of the warning code. 564 }, 565 ], 566 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 567}</pre> 568</div> 569 570</body></html>