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.targetHttpsProxies.html">targetHttpsProxies</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 TargetHttpsProxy 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, targetHttpsProxy, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, targetHttpsProxy, x__xgafv=None)</a></code></p> 91<p class="firstline">Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS 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 TargetHttpsProxy 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 TargetHttpsProxy 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, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Patches the specified TargetHttpsProxy 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="#setCertificateMap">setCertificateMap(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Changes the Certificate Map for TargetHttpsProxy.</p> 107<p class="toc_element"> 108 <code><a href="#setQuicOverride">setQuicOverride(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Sets the QUIC override policy for TargetHttpsProxy.</p> 110<p class="toc_element"> 111 <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p> 113<p class="toc_element"> 114 <code><a href="#setSslPolicy">setSslPolicy(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.</p> 116<p class="toc_element"> 117 <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Changes the URL map for TargetHttpsProxy.</p> 119<p class="toc_element"> 120 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 122<h3>Method Details</h3> 123<div class="method"> 124 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 125 <pre>Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. 126 127Args: 128 project: string, Name of the project scoping this request. (required) 129 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) ``` 130 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. 131 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`) 132 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. 133 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. 134 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139 140Returns: 141 An object of the form: 142 143 { 144 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 145 "items": { # A list of TargetHttpsProxiesScopedList resources. 146 "a_key": { # Name of the scope containing this set of TargetHttpsProxies. 147 "targetHttpsProxies": [ # A list of TargetHttpsProxies contained in this scope. 148 { # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 149 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 150 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 151 "authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. 152 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. 153 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 154 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 155 "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. 156 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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. 157 "A String", 158 ], 159 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 160 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 161 "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. 162 "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. 163 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. 164 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 166 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 167 "serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact. 168 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 169 "A String", 170 ], 171 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. 172 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map 173 }, 174 ], 175 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 176 "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. 177 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 178 { 179 "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). 180 "value": "A String", # [Output Only] A warning data value corresponding to the key. 181 }, 182 ], 183 "message": "A String", # [Output Only] A human-readable description of the warning code. 184 }, 185 }, 186 }, 187 "kind": "compute#targetHttpsProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. 188 "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. 189 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 190 "unreachables": [ # [Output Only] Unreachable resources. 191 "A String", 192 ], 193 "warning": { # [Output Only] Informational warning message. 194 "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. 195 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 196 { 197 "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). 198 "value": "A String", # [Output Only] A warning data value corresponding to the key. 199 }, 200 ], 201 "message": "A String", # [Output Only] A human-readable description of the warning code. 202 }, 203}</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 208 <pre>Retrieves the next page of results. 209 210Args: 211 previous_request: The request for the previous page. (required) 212 previous_response: The response from the request for the previous page. (required) 213 214Returns: 215 A request object that you can call 'execute()' on to request the next 216 page. Returns None if there are no more items in the collection. 217 </pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="close">close()</code> 222 <pre>Close httplib2 connections.</pre> 223</div> 224 225<div class="method"> 226 <code class="details" id="delete">delete(project, targetHttpsProxy, requestId=None, x__xgafv=None)</code> 227 <pre>Deletes the specified TargetHttpsProxy resource. 228 229Args: 230 project: string, Project ID for this request. (required) 231 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required) 232 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). 233 x__xgafv: string, V1 error format. 234 Allowed values 235 1 - v1 error format 236 2 - v2 error format 237 238Returns: 239 An object of the form: 240 241 { # 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. 242 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 243 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 244 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 245 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 246 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 247 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 248 { 249 "code": "A String", # [Output Only] The error type identifier for this error. 250 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 251 "message": "A String", # [Output Only] An optional, human-readable error message. 252 }, 253 ], 254 }, 255 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 256 "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. 257 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 258 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 259 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 260 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 261 "a_key": "", # Properties of the object. Contains field @type with type URL. 262 }, 263 "name": "A String", # [Output Only] Name of the operation. 264 "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. 265 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 266 "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. 267 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 268 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 269 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 270 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 271 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 272 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 273 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 274 "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. 275 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 276 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 277 { 278 "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. 279 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 280 { 281 "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). 282 "value": "A String", # [Output Only] A warning data value corresponding to the key. 283 }, 284 ], 285 "message": "A String", # [Output Only] A human-readable description of the warning code. 286 }, 287 ], 288 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 289}</pre> 290</div> 291 292<div class="method"> 293 <code class="details" id="get">get(project, targetHttpsProxy, x__xgafv=None)</code> 294 <pre>Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. 295 296Args: 297 project: string, Project ID for this request. (required) 298 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required) 299 x__xgafv: string, V1 error format. 300 Allowed values 301 1 - v1 error format 302 2 - v2 error format 303 304Returns: 305 An object of the form: 306 307 { # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 308 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 309 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 310 "authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. 311 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. 312 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 313 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 314 "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. 315 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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. 316 "A String", 317 ], 318 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 319 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 320 "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. 321 "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. 322 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. 323 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 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 "serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact. 327 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 328 "A String", 329 ], 330 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. 331 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map 332}</pre> 333</div> 334 335<div class="method"> 336 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 337 <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request. 338 339Args: 340 project: string, Project ID for this request. (required) 341 body: object, The request body. 342 The object takes the form of: 343 344{ # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 345 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 346 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 347 "authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. 348 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. 349 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 350 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 351 "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. 352 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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. 353 "A String", 354 ], 355 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 356 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 357 "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. 358 "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. 359 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. 360 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 361 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 362 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 363 "serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact. 364 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 365 "A String", 366 ], 367 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. 368 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map 369} 370 371 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). 372 x__xgafv: string, V1 error format. 373 Allowed values 374 1 - v1 error format 375 2 - v2 error format 376 377Returns: 378 An object of the form: 379 380 { # 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. 381 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 382 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 383 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 384 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 385 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 386 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 387 { 388 "code": "A String", # [Output Only] The error type identifier for this error. 389 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 390 "message": "A String", # [Output Only] An optional, human-readable error message. 391 }, 392 ], 393 }, 394 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 395 "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. 396 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 397 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 398 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 399 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 400 "a_key": "", # Properties of the object. Contains field @type with type URL. 401 }, 402 "name": "A String", # [Output Only] Name of the operation. 403 "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. 404 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 405 "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. 406 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 407 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 408 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 409 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 410 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 411 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 412 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 413 "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. 414 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 415 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 416 { 417 "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. 418 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 419 { 420 "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). 421 "value": "A String", # [Output Only] A warning data value corresponding to the key. 422 }, 423 ], 424 "message": "A String", # [Output Only] A human-readable description of the warning code. 425 }, 426 ], 427 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 428}</pre> 429</div> 430 431<div class="method"> 432 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 433 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project. 434 435Args: 436 project: string, Project ID for this request. (required) 437 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) ``` 438 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`) 439 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. 440 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. 441 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 442 x__xgafv: string, V1 error format. 443 Allowed values 444 1 - v1 error format 445 2 - v2 error format 446 447Returns: 448 An object of the form: 449 450 { # Contains a list of TargetHttpsProxy resources. 451 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 452 "items": [ # A list of TargetHttpsProxy resources. 453 { # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 454 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 455 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 456 "authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. 457 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. 458 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 459 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 460 "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. 461 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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. 462 "A String", 463 ], 464 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 465 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 466 "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. 467 "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. 468 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. 469 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 470 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 471 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 472 "serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact. 473 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 474 "A String", 475 ], 476 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. 477 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map 478 }, 479 ], 480 "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. 481 "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. 482 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 483 "warning": { # [Output Only] Informational warning message. 484 "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. 485 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 486 { 487 "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). 488 "value": "A String", # [Output Only] A warning data value corresponding to the key. 489 }, 490 ], 491 "message": "A String", # [Output Only] A human-readable description of the warning code. 492 }, 493}</pre> 494</div> 495 496<div class="method"> 497 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 498 <pre>Retrieves the next page of results. 499 500Args: 501 previous_request: The request for the previous page. (required) 502 previous_response: The response from the request for the previous page. (required) 503 504Returns: 505 A request object that you can call 'execute()' on to request the next 506 page. Returns None if there are no more items in the collection. 507 </pre> 508</div> 509 510<div class="method"> 511 <code class="details" id="patch">patch(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 512 <pre>Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. 513 514Args: 515 project: string, Project ID for this request. (required) 516 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to patch. (required) 517 body: object, The request body. 518 The object takes the form of: 519 520{ # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. 521 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 522 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 523 "authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. 524 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. 525 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 526 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 527 "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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. 528 "httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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. 529 "A String", 530 ], 531 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 532 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 533 "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. 534 "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. 535 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. 536 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 537 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 538 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 539 "serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact. 540 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 541 "A String", 542 ], 543 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. 544 "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map 545} 546 547 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). 548 x__xgafv: string, V1 error format. 549 Allowed values 550 1 - v1 error format 551 2 - v2 error format 552 553Returns: 554 An object of the form: 555 556 { # 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. 557 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 558 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 559 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 560 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 561 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 562 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 563 { 564 "code": "A String", # [Output Only] The error type identifier for this error. 565 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 566 "message": "A String", # [Output Only] An optional, human-readable error message. 567 }, 568 ], 569 }, 570 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 571 "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. 572 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 573 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 574 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 575 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 576 "a_key": "", # Properties of the object. Contains field @type with type URL. 577 }, 578 "name": "A String", # [Output Only] Name of the operation. 579 "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. 580 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 581 "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. 582 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 583 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 584 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 585 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 586 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 587 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 588 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 589 "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. 590 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 591 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 592 { 593 "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. 594 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 595 { 596 "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). 597 "value": "A String", # [Output Only] A warning data value corresponding to the key. 598 }, 599 ], 600 "message": "A String", # [Output Only] A human-readable description of the warning code. 601 }, 602 ], 603 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 604}</pre> 605</div> 606 607<div class="method"> 608 <code class="details" id="setCertificateMap">setCertificateMap(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 609 <pre>Changes the Certificate Map for TargetHttpsProxy. 610 611Args: 612 project: string, Project ID for this request. (required) 613 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required) 614 body: object, The request body. 615 The object takes the form of: 616 617{ 618 "certificateMap": "A String", # URL of the Certificate Map to associate with this TargetHttpsProxy. 619} 620 621 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). 622 x__xgafv: string, V1 error format. 623 Allowed values 624 1 - v1 error format 625 2 - v2 error format 626 627Returns: 628 An object of the form: 629 630 { # 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. 631 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 632 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 633 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 634 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 635 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 636 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 637 { 638 "code": "A String", # [Output Only] The error type identifier for this error. 639 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 640 "message": "A String", # [Output Only] An optional, human-readable error message. 641 }, 642 ], 643 }, 644 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 645 "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. 646 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 647 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 648 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 649 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 650 "a_key": "", # Properties of the object. Contains field @type with type URL. 651 }, 652 "name": "A String", # [Output Only] Name of the operation. 653 "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. 654 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 655 "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. 656 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 657 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 658 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 659 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 660 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 661 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 662 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 663 "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. 664 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 665 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 666 { 667 "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. 668 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 669 { 670 "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). 671 "value": "A String", # [Output Only] A warning data value corresponding to the key. 672 }, 673 ], 674 "message": "A String", # [Output Only] A human-readable description of the warning code. 675 }, 676 ], 677 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 678}</pre> 679</div> 680 681<div class="method"> 682 <code class="details" id="setQuicOverride">setQuicOverride(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 683 <pre>Sets the QUIC override policy for TargetHttpsProxy. 684 685Args: 686 project: string, Project ID for this request. (required) 687 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. (required) 688 body: object, The request body. 689 The object takes the form of: 690 691{ 692 "quicOverride": "A String", # QUIC policy for the TargetHttpsProxy resource. 693} 694 695 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). 696 x__xgafv: string, V1 error format. 697 Allowed values 698 1 - v1 error format 699 2 - v2 error format 700 701Returns: 702 An object of the form: 703 704 { # 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. 705 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 706 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 707 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 708 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 709 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 710 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 711 { 712 "code": "A String", # [Output Only] The error type identifier for this error. 713 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 714 "message": "A String", # [Output Only] An optional, human-readable error message. 715 }, 716 ], 717 }, 718 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 719 "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. 720 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 721 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 722 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 723 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 724 "a_key": "", # Properties of the object. Contains field @type with type URL. 725 }, 726 "name": "A String", # [Output Only] Name of the operation. 727 "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. 728 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 729 "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. 730 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 731 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 732 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 733 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 734 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 735 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 736 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 737 "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. 738 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 739 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 740 { 741 "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. 742 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 743 { 744 "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). 745 "value": "A String", # [Output Only] A warning data value corresponding to the key. 746 }, 747 ], 748 "message": "A String", # [Output Only] A human-readable description of the warning code. 749 }, 750 ], 751 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 752}</pre> 753</div> 754 755<div class="method"> 756 <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 757 <pre>Replaces SslCertificates for TargetHttpsProxy. 758 759Args: 760 project: string, Project ID for this request. (required) 761 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required) 762 body: object, The request body. 763 The object takes the form of: 764 765{ 766 "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. 767 "A String", 768 ], 769} 770 771 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). 772 x__xgafv: string, V1 error format. 773 Allowed values 774 1 - v1 error format 775 2 - v2 error format 776 777Returns: 778 An object of the form: 779 780 { # 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. 781 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 782 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 783 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 784 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 785 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 786 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 787 { 788 "code": "A String", # [Output Only] The error type identifier for this error. 789 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 790 "message": "A String", # [Output Only] An optional, human-readable error message. 791 }, 792 ], 793 }, 794 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 795 "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. 796 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 797 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 798 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 799 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 800 "a_key": "", # Properties of the object. Contains field @type with type URL. 801 }, 802 "name": "A String", # [Output Only] Name of the operation. 803 "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. 804 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 805 "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. 806 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 807 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 808 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 809 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 810 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 811 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 812 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 813 "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. 814 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 815 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 816 { 817 "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. 818 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 819 { 820 "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). 821 "value": "A String", # [Output Only] A warning data value corresponding to the key. 822 }, 823 ], 824 "message": "A String", # [Output Only] A human-readable description of the warning code. 825 }, 826 ], 827 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 828}</pre> 829</div> 830 831<div class="method"> 832 <code class="details" id="setSslPolicy">setSslPolicy(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 833 <pre>Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. 834 835Args: 836 project: string, Project ID for this request. (required) 837 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required) 838 body: object, The request body. 839 The object takes the form of: 840 841{ 842 "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. 843} 844 845 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). 846 x__xgafv: string, V1 error format. 847 Allowed values 848 1 - v1 error format 849 2 - v2 error format 850 851Returns: 852 An object of the form: 853 854 { # 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. 855 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 856 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 857 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 858 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 859 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 860 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 861 { 862 "code": "A String", # [Output Only] The error type identifier for this error. 863 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 864 "message": "A String", # [Output Only] An optional, human-readable error message. 865 }, 866 ], 867 }, 868 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 869 "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. 870 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 871 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 872 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 873 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 874 "a_key": "", # Properties of the object. Contains field @type with type URL. 875 }, 876 "name": "A String", # [Output Only] Name of the operation. 877 "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. 878 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 879 "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. 880 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 881 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 882 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 883 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 884 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 885 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 886 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 887 "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. 888 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 889 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 890 { 891 "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. 892 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 893 { 894 "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). 895 "value": "A String", # [Output Only] A warning data value corresponding to the key. 896 }, 897 ], 898 "message": "A String", # [Output Only] A human-readable description of the warning code. 899 }, 900 ], 901 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 902}</pre> 903</div> 904 905<div class="method"> 906 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 907 <pre>Changes the URL map for TargetHttpsProxy. 908 909Args: 910 project: string, Project ID for this request. (required) 911 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required) 912 body: object, The request body. 913 The object takes the form of: 914 915{ 916 "urlMap": "A String", 917} 918 919 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). 920 x__xgafv: string, V1 error format. 921 Allowed values 922 1 - v1 error format 923 2 - v2 error format 924 925Returns: 926 An object of the form: 927 928 { # 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. 929 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 930 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 931 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 932 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 933 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 934 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 935 { 936 "code": "A String", # [Output Only] The error type identifier for this error. 937 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 938 "message": "A String", # [Output Only] An optional, human-readable error message. 939 }, 940 ], 941 }, 942 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 943 "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. 944 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 945 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 946 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 947 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 948 "a_key": "", # Properties of the object. Contains field @type with type URL. 949 }, 950 "name": "A String", # [Output Only] Name of the operation. 951 "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. 952 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 953 "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. 954 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 955 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 956 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 957 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 958 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 959 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 960 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 961 "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. 962 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 963 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 964 { 965 "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. 966 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 967 { 968 "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). 969 "value": "A String", # [Output Only] A warning data value corresponding to the key. 970 }, 971 ], 972 "message": "A String", # [Output Only] A human-readable description of the warning code. 973 }, 974 ], 975 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 976}</pre> 977</div> 978 979<div class="method"> 980 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 981 <pre>Returns permissions that a caller has on the specified resource. 982 983Args: 984 project: string, Project ID for this request. (required) 985 resource: string, Name or id of the resource for this request. (required) 986 body: object, The request body. 987 The object takes the form of: 988 989{ 990 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 991 "A String", 992 ], 993} 994 995 x__xgafv: string, V1 error format. 996 Allowed values 997 1 - v1 error format 998 2 - v2 error format 999 1000Returns: 1001 An object of the form: 1002 1003 { 1004 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1005 "A String", 1006 ], 1007}</pre> 1008</div> 1009 1010</body></html>