1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.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<p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 113 <pre>Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. 114 115Args: 116 project: string, Name of the project scoping this request. (required) 117 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) ``` 118 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. 119 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`) 120 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. 121 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. 122 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { 132 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 133 "items": { # A list of TargetHttpProxiesScopedList resources. 134 "a_key": { # Name of the scope containing this set of TargetHttpProxies. 135 "targetHttpProxies": [ # A list of TargetHttpProxies contained in this scope. 136 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/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. 137 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 138 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 139 "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. 140 "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. 141 "A String", 142 ], 143 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 144 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 145 "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. 146 "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. 147 "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. 148 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 149 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 150 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 151 }, 152 ], 153 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 154 "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. 155 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 156 { 157 "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). 158 "value": "A String", # [Output Only] A warning data value corresponding to the key. 159 }, 160 ], 161 "message": "A String", # [Output Only] A human-readable description of the warning code. 162 }, 163 }, 164 }, 165 "kind": "compute#targetHttpProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. 166 "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. 167 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 168 "unreachables": [ # [Output Only] Unreachable resources. 169 "A String", 170 ], 171 "warning": { # [Output Only] Informational warning message. 172 "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. 173 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 174 { 175 "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). 176 "value": "A String", # [Output Only] A warning data value corresponding to the key. 177 }, 178 ], 179 "message": "A String", # [Output Only] A human-readable description of the warning code. 180 }, 181}</pre> 182</div> 183 184<div class="method"> 185 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 186 <pre>Retrieves the next page of results. 187 188Args: 189 previous_request: The request for the previous page. (required) 190 previous_response: The response from the request for the previous page. (required) 191 192Returns: 193 A request object that you can call 'execute()' on to request the next 194 page. Returns None if there are no more items in the collection. 195 </pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="close">close()</code> 200 <pre>Close httplib2 connections.</pre> 201</div> 202 203<div class="method"> 204 <code class="details" id="delete">delete(project, targetHttpProxy, requestId=None, x__xgafv=None)</code> 205 <pre>Deletes the specified TargetHttpProxy resource. 206 207Args: 208 project: string, Project ID for this request. (required) 209 targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required) 210 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). 211 x__xgafv: string, V1 error format. 212 Allowed values 213 1 - v1 error format 214 2 - v2 error format 215 216Returns: 217 An object of the form: 218 219 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 220 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 221 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 222 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 223 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 224 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 225 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 226 { 227 "code": "A String", # [Output Only] The error type identifier for this error. 228 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 229 "message": "A String", # [Output Only] An optional, human-readable error message. 230 }, 231 ], 232 }, 233 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 234 "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. 235 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 236 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 237 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 238 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 239 "a_key": "", # Properties of the object. Contains field @type with type URL. 240 }, 241 "name": "A String", # [Output Only] Name of the operation. 242 "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. 243 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 244 "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. 245 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 246 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 247 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 248 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 249 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 250 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 251 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 252 "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. 253 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 254 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 255 { 256 "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. 257 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 258 { 259 "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). 260 "value": "A String", # [Output Only] A warning data value corresponding to the key. 261 }, 262 ], 263 "message": "A String", # [Output Only] A human-readable description of the warning code. 264 }, 265 ], 266 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 267}</pre> 268</div> 269 270<div class="method"> 271 <code class="details" id="get">get(project, targetHttpProxy, x__xgafv=None)</code> 272 <pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. 273 274Args: 275 project: string, Project ID for this request. (required) 276 targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required) 277 x__xgafv: string, V1 error format. 278 Allowed values 279 1 - v1 error format 280 2 - v2 error format 281 282Returns: 283 An object of the form: 284 285 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/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. 286 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 288 "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. 289 "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. 290 "A String", 291 ], 292 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 293 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 294 "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. 295 "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. 296 "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. 297 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 298 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 299 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 300}</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 305 <pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request. 306 307Args: 308 project: string, Project ID for this request. (required) 309 body: object, The request body. 310 The object takes the form of: 311 312{ # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/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. 313 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 314 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 315 "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. 316 "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. 317 "A String", 318 ], 319 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 320 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 321 "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. 322 "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. 323 "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. 324 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 325 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 326 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 327} 328 329 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). 330 x__xgafv: string, V1 error format. 331 Allowed values 332 1 - v1 error format 333 2 - v2 error format 334 335Returns: 336 An object of the form: 337 338 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 339 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 340 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 341 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 342 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 343 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 344 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 345 { 346 "code": "A String", # [Output Only] The error type identifier for this error. 347 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 348 "message": "A String", # [Output Only] An optional, human-readable error message. 349 }, 350 ], 351 }, 352 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 353 "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. 354 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 355 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 356 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 357 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 358 "a_key": "", # Properties of the object. Contains field @type with type URL. 359 }, 360 "name": "A String", # [Output Only] Name of the operation. 361 "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. 362 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 363 "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. 364 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 365 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 366 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 367 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 368 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 369 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 370 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 371 "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. 372 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 373 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 374 { 375 "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. 376 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 377 { 378 "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). 379 "value": "A String", # [Output Only] A warning data value corresponding to the key. 380 }, 381 ], 382 "message": "A String", # [Output Only] A human-readable description of the warning code. 383 }, 384 ], 385 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 386}</pre> 387</div> 388 389<div class="method"> 390 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 391 <pre>Retrieves the list of TargetHttpProxy resources available to the specified project. 392 393Args: 394 project: string, Project ID for this request. (required) 395 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) ``` 396 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`) 397 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. 398 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. 399 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 400 x__xgafv: string, V1 error format. 401 Allowed values 402 1 - v1 error format 403 2 - v2 error format 404 405Returns: 406 An object of the form: 407 408 { # A list of TargetHttpProxy resources. 409 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 410 "items": [ # A list of TargetHttpProxy resources. 411 { # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/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. 412 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 413 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 414 "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. 415 "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. 416 "A String", 417 ], 418 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 419 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 420 "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. 421 "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. 422 "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. 423 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 424 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 425 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 426 }, 427 ], 428 "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies. 429 "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. 430 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 431 "warning": { # [Output Only] Informational warning message. 432 "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. 433 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 434 { 435 "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). 436 "value": "A String", # [Output Only] A warning data value corresponding to the key. 437 }, 438 ], 439 "message": "A String", # [Output Only] A human-readable description of the warning code. 440 }, 441}</pre> 442</div> 443 444<div class="method"> 445 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 446 <pre>Retrieves the next page of results. 447 448Args: 449 previous_request: The request for the previous page. (required) 450 previous_response: The response from the request for the previous page. (required) 451 452Returns: 453 A request object that you can call 'execute()' on to request the next 454 page. Returns None if there are no more items in the collection. 455 </pre> 456</div> 457 458<div class="method"> 459 <code class="details" id="patch">patch(project, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</code> 460 <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. 461 462Args: 463 project: string, Project ID for this request. (required) 464 targetHttpProxy: string, Name of the TargetHttpProxy resource to patch. (required) 465 body: object, The request body. 466 The object takes the form of: 467 468{ # Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/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. 469 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 470 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 471 "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. 472 "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. 473 "A String", 474 ], 475 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 476 "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. 477 "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. 478 "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. 479 "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. 480 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 481 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 482 "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService. 483} 484 485 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). 486 x__xgafv: string, V1 error format. 487 Allowed values 488 1 - v1 error format 489 2 - v2 error format 490 491Returns: 492 An object of the form: 493 494 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 495 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 496 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 497 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 498 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 499 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 500 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 501 { 502 "code": "A String", # [Output Only] The error type identifier for this error. 503 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 504 "message": "A String", # [Output Only] An optional, human-readable error message. 505 }, 506 ], 507 }, 508 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 509 "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. 510 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 511 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 512 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 513 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 514 "a_key": "", # Properties of the object. Contains field @type with type URL. 515 }, 516 "name": "A String", # [Output Only] Name of the operation. 517 "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. 518 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 519 "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. 520 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 521 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 522 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 523 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 524 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 525 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 526 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 527 "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. 528 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 529 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 530 { 531 "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. 532 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 533 { 534 "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). 535 "value": "A String", # [Output Only] A warning data value corresponding to the key. 536 }, 537 ], 538 "message": "A String", # [Output Only] A human-readable description of the warning code. 539 }, 540 ], 541 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 542}</pre> 543</div> 544 545<div class="method"> 546 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None, x__xgafv=None)</code> 547 <pre>Changes the URL map for TargetHttpProxy. 548 549Args: 550 project: string, Project ID for this request. (required) 551 targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required) 552 body: object, The request body. 553 The object takes the form of: 554 555{ 556 "urlMap": "A String", 557} 558 559 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). 560 x__xgafv: string, V1 error format. 561 Allowed values 562 1 - v1 error format 563 2 - v2 error format 564 565Returns: 566 An object of the form: 567 568 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 569 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 570 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 571 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 572 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 573 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 574 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 575 { 576 "code": "A String", # [Output Only] The error type identifier for this error. 577 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 578 "message": "A String", # [Output Only] An optional, human-readable error message. 579 }, 580 ], 581 }, 582 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 583 "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. 584 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 585 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 586 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 587 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 588 "a_key": "", # Properties of the object. Contains field @type with type URL. 589 }, 590 "name": "A String", # [Output Only] Name of the operation. 591 "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. 592 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 593 "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. 594 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 595 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 596 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 597 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 598 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 599 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 600 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 601 "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. 602 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 603 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 604 { 605 "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. 606 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 607 { 608 "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). 609 "value": "A String", # [Output Only] A warning data value corresponding to the key. 610 }, 611 ], 612 "message": "A String", # [Output Only] A human-readable description of the warning code. 613 }, 614 ], 615 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 616}</pre> 617</div> 618 619<div class="method"> 620 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 621 <pre>Returns permissions that a caller has on the specified resource. 622 623Args: 624 project: string, Project ID for this request. (required) 625 resource: string, Name or id of the resource for this request. (required) 626 body: object, The request body. 627 The object takes the form of: 628 629{ 630 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 631 "A String", 632 ], 633} 634 635 x__xgafv: string, V1 error format. 636 Allowed values 637 1 - v1 error format 638 2 - v2 error format 639 640Returns: 641 An object of the form: 642 643 { 644 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 645 "A String", 646 ], 647}</pre> 648</div> 649 650</body></html>