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.regionTargetHttpProxies.html">regionTargetHttpProxies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, region, targetHttpProxy, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified TargetHttpProxy resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, region, targetHttpProxy, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#setUrlMap">setUrlMap(project, region, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Changes the URL map for TargetHttpProxy.</p> 98<p class="toc_element"> 99 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(project, region, targetHttpProxy, requestId=None, x__xgafv=None)</code> 109 <pre>Deletes the specified TargetHttpProxy resource. 110 111Args: 112 project: string, Project ID for this request. (required) 113 region: string, Name of the region scoping this request. (required) 114 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required) 115 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). 116 x__xgafv: string, V1 error format. 117 Allowed values 118 1 - v1 error format 119 2 - v2 error format 120 121Returns: 122 An object of the form: 123 124 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 125 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 126 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 127 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 128 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 129 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 130 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 131 { 132 "code": "A String", # [Output Only] The error type identifier for this error. 133 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 134 "message": "A String", # [Output Only] An optional, human-readable error message. 135 }, 136 ], 137 }, 138 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 139 "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. 140 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 141 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 142 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 143 "name": "A String", # [Output Only] Name of the operation. 144 "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. 145 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 146 "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. 147 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 148 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 149 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 150 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 151 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 152 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 153 "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. 154 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 155 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 156 { 157 "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. 158 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 159 { 160 "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). 161 "value": "A String", # [Output Only] A warning data value corresponding to the key. 162 }, 163 ], 164 "message": "A String", # [Output Only] A human-readable description of the warning code. 165 }, 166 ], 167 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 168}</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="get">get(project, region, targetHttpProxy, x__xgafv=None)</code> 173 <pre>Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. 174 175Args: 176 project: string, Project ID for this request. (required) 177 region: string, Name of the region scoping this request. (required) 178 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required) 179 x__xgafv: string, V1 error format. 180 Allowed values 181 1 - v1 error format 182 2 - v2 error format 183 184Returns: 185 An object of the form: 186 187 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/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. 188 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 189 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 190 "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. 191 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/ locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. 192 "A String", 193 ], 194 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 195 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 196 "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. 197 "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. 198 "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. 199 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 200 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 201}</pre> 202</div> 203 204<div class="method"> 205 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 206 <pre>Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. 207 208Args: 209 project: string, Project ID for this request. (required) 210 region: string, Name of the region scoping this request. (required) 211 body: object, The request body. 212 The object takes the form of: 213 214{ # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/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. 215 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 216 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 217 "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. 218 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/ locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. 219 "A String", 220 ], 221 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 222 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 223 "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. 224 "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. 225 "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. 226 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 227 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 228} 229 230 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). 231 x__xgafv: string, V1 error format. 232 Allowed values 233 1 - v1 error format 234 2 - v2 error format 235 236Returns: 237 An object of the form: 238 239 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 240 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 241 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 242 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 243 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 244 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 245 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 246 { 247 "code": "A String", # [Output Only] The error type identifier for this error. 248 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 249 "message": "A String", # [Output Only] An optional, human-readable error message. 250 }, 251 ], 252 }, 253 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 254 "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. 255 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 256 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 257 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 258 "name": "A String", # [Output Only] Name of the operation. 259 "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. 260 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 261 "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. 262 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 263 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 264 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 265 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 266 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 267 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 268 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 269 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 270 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 271 { 272 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 273 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 274 { 275 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 276 "value": "A String", # [Output Only] A warning data value corresponding to the key. 277 }, 278 ], 279 "message": "A String", # [Output Only] A human-readable description of the warning code. 280 }, 281 ], 282 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 283}</pre> 284</div> 285 286<div class="method"> 287 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 288 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. 289 290Args: 291 project: string, Project ID for this request. (required) 292 region: string, Name of the region scoping this request. (required) 293 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) ``` 294 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`) 295 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. 296 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. 297 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { # A list of TargetHttpProxy resources. 307 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 308 "items": [ # A list of TargetHttpProxy resources. 309 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/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. 310 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 311 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 312 "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. 313 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/ locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list. httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. 314 "A String", 315 ], 316 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 317 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 318 "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. 319 "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. 320 "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. 321 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 322 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 323 }, 324 ], 325 "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. 326 "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. 327 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 328 "warning": { # [Output Only] Informational warning message. 329 "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. 330 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 331 { 332 "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). 333 "value": "A String", # [Output Only] A warning data value corresponding to the key. 334 }, 335 ], 336 "message": "A String", # [Output Only] A human-readable description of the warning code. 337 }, 338}</pre> 339</div> 340 341<div class="method"> 342 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 343 <pre>Retrieves the next page of results. 344 345Args: 346 previous_request: The request for the previous page. (required) 347 previous_response: The response from the request for the previous page. (required) 348 349Returns: 350 A request object that you can call 'execute()' on to request the next 351 page. Returns None if there are no more items in the collection. 352 </pre> 353</div> 354 355<div class="method"> 356 <code class="details" id="setUrlMap">setUrlMap(project, region, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</code> 357 <pre>Changes the URL map for TargetHttpProxy. 358 359Args: 360 project: string, Project ID for this request. (required) 361 region: string, Name of the region scoping this request. (required) 362 targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required) 363 body: object, The request body. 364 The object takes the form of: 365 366{ 367 "urlMap": "A String", 368} 369 370 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). 371 x__xgafv: string, V1 error format. 372 Allowed values 373 1 - v1 error format 374 2 - v2 error format 375 376Returns: 377 An object of the form: 378 379 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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. 380 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 381 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 382 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 383 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 384 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 385 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 386 { 387 "code": "A String", # [Output Only] The error type identifier for this error. 388 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 389 "message": "A String", # [Output Only] An optional, human-readable error message. 390 }, 391 ], 392 }, 393 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 394 "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. 395 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 396 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 397 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 398 "name": "A String", # [Output Only] Name of the operation. 399 "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. 400 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 401 "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. 402 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 403 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 404 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 405 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 406 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 407 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 408 "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. 409 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 410 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 411 { 412 "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. 413 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 414 { 415 "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). 416 "value": "A String", # [Output Only] A warning data value corresponding to the key. 417 }, 418 ], 419 "message": "A String", # [Output Only] A human-readable description of the warning code. 420 }, 421 ], 422 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 423}</pre> 424</div> 425 426<div class="method"> 427 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> 428 <pre>Returns permissions that a caller has on the specified resource. 429 430Args: 431 project: string, Project ID for this request. (required) 432 region: string, The name of the region for this request. (required) 433 resource: string, Name or id of the resource for this request. (required) 434 body: object, The request body. 435 The object takes the form of: 436 437{ 438 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 439 "A String", 440 ], 441} 442 443 x__xgafv: string, V1 error format. 444 Allowed values 445 1 - v1 error format 446 2 - v2 error format 447 448Returns: 449 An object of the form: 450 451 { 452 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 453 "A String", 454 ], 455}</pre> 456</div> 457 458</body></html>