1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.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/beta/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/beta/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 "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. 167 "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. 168 "A String", 169 ], 170 "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. 171 "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 172 }, 173 ], 174 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 175 "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. 176 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 177 { 178 "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). 179 "value": "A String", # [Output Only] A warning data value corresponding to the key. 180 }, 181 ], 182 "message": "A String", # [Output Only] A human-readable description of the warning code. 183 }, 184 }, 185 }, 186 "kind": "compute#targetHttpsProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. 187 "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. 188 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 189 "unreachables": [ # [Output Only] Unreachable resources. 190 "A String", 191 ], 192 "warning": { # [Output Only] Informational warning message. 193 "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. 194 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 195 { 196 "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). 197 "value": "A String", # [Output Only] A warning data value corresponding to the key. 198 }, 199 ], 200 "message": "A String", # [Output Only] A human-readable description of the warning code. 201 }, 202}</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 207 <pre>Retrieves the next page of results. 208 209Args: 210 previous_request: The request for the previous page. (required) 211 previous_response: The response from the request for the previous page. (required) 212 213Returns: 214 A request object that you can call 'execute()' on to request the next 215 page. Returns None if there are no more items in the collection. 216 </pre> 217</div> 218 219<div class="method"> 220 <code class="details" id="close">close()</code> 221 <pre>Close httplib2 connections.</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="delete">delete(project, targetHttpsProxy, requestId=None, x__xgafv=None)</code> 226 <pre>Deletes the specified TargetHttpsProxy resource. 227 228Args: 229 project: string, Project ID for this request. (required) 230 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required) 231 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). 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 241 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 242 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 243 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 244 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 245 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 246 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 247 { 248 "code": "A String", # [Output Only] The error type identifier for this error. 249 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 250 "message": "A String", # [Output Only] An optional, human-readable error message. 251 }, 252 ], 253 }, 254 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 255 "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. 256 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 257 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 258 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 259 "name": "A String", # [Output Only] Name of the operation. 260 "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. 261 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 262 "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. 263 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 264 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 265 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 266 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 267 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 268 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 269 "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. 270 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 271 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 272 { 273 "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. 274 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 275 { 276 "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). 277 "value": "A String", # [Output Only] A warning data value corresponding to the key. 278 }, 279 ], 280 "message": "A String", # [Output Only] A human-readable description of the warning code. 281 }, 282 ], 283 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 284}</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="get">get(project, targetHttpsProxy, x__xgafv=None)</code> 289 <pre>Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. 290 291Args: 292 project: string, Project ID for this request. (required) 293 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required) 294 x__xgafv: string, V1 error format. 295 Allowed values 296 1 - v1 error format 297 2 - v2 error format 298 299Returns: 300 An object of the form: 301 302 { # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/beta/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. 303 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 304 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 305 "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. 306 "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. 307 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 308 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 309 "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. 310 "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. 311 "A String", 312 ], 313 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 314 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 315 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 316 "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. 317 "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. 318 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 319 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 320 "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. 321 "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. 322 "A String", 323 ], 324 "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. 325 "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 326}</pre> 327</div> 328 329<div class="method"> 330 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 331 <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request. 332 333Args: 334 project: string, Project ID for this request. (required) 335 body: object, The request body. 336 The object takes the form of: 337 338{ # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/beta/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. 339 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 340 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 341 "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. 342 "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. 343 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 344 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 345 "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. 346 "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. 347 "A String", 348 ], 349 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 350 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 351 "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. 352 "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. 353 "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. 354 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 355 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 356 "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. 357 "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. 358 "A String", 359 ], 360 "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. 361 "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 362} 363 364 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). 365 x__xgafv: string, V1 error format. 366 Allowed values 367 1 - v1 error format 368 2 - v2 error format 369 370Returns: 371 An object of the form: 372 373 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 374 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 375 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 376 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 377 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 378 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 379 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 380 { 381 "code": "A String", # [Output Only] The error type identifier for this error. 382 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 383 "message": "A String", # [Output Only] An optional, human-readable error message. 384 }, 385 ], 386 }, 387 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 388 "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. 389 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 390 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 391 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 392 "name": "A String", # [Output Only] Name of the operation. 393 "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. 394 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 395 "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. 396 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 397 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 398 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 399 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 400 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 401 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 402 "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. 403 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 404 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 405 { 406 "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. 407 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 408 { 409 "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). 410 "value": "A String", # [Output Only] A warning data value corresponding to the key. 411 }, 412 ], 413 "message": "A String", # [Output Only] A human-readable description of the warning code. 414 }, 415 ], 416 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 417}</pre> 418</div> 419 420<div class="method"> 421 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 422 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project. 423 424Args: 425 project: string, Project ID for this request. (required) 426 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) ``` 427 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`) 428 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. 429 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. 430 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 431 x__xgafv: string, V1 error format. 432 Allowed values 433 1 - v1 error format 434 2 - v2 error format 435 436Returns: 437 An object of the form: 438 439 { # Contains a list of TargetHttpsProxy resources. 440 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 441 "items": [ # A list of TargetHttpsProxy resources. 442 { # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/beta/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. 443 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 444 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 445 "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. 446 "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. 447 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 448 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 449 "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. 450 "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. 451 "A String", 452 ], 453 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 454 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 455 "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. 456 "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. 457 "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. 458 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 459 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 460 "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. 461 "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. 462 "A String", 463 ], 464 "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. 465 "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 466 }, 467 ], 468 "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies. 469 "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. 470 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 471 "warning": { # [Output Only] Informational warning message. 472 "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. 473 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 474 { 475 "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). 476 "value": "A String", # [Output Only] A warning data value corresponding to the key. 477 }, 478 ], 479 "message": "A String", # [Output Only] A human-readable description of the warning code. 480 }, 481}</pre> 482</div> 483 484<div class="method"> 485 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 486 <pre>Retrieves the next page of results. 487 488Args: 489 previous_request: The request for the previous page. (required) 490 previous_response: The response from the request for the previous page. (required) 491 492Returns: 493 A request object that you can call 'execute()' on to request the next 494 page. Returns None if there are no more items in the collection. 495 </pre> 496</div> 497 498<div class="method"> 499 <code class="details" id="patch">patch(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 500 <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. 501 502Args: 503 project: string, Project ID for this request. (required) 504 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to patch. (required) 505 body: object, The request body. 506 The object takes the form of: 507 508{ # Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/beta/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. 509 "authentication": "A String", # [Deprecated] Use serverTlsPolicy instead. 510 "authorization": "A String", # [Deprecated] Use authorizationPolicy instead. 511 "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. 512 "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. 513 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 514 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 515 "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. 516 "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. 517 "A String", 518 ], 519 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 520 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. 521 "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. 522 "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. 523 "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. 524 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. 525 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 526 "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. 527 "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. 528 "A String", 529 ], 530 "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. 531 "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 532} 533 534 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). 535 x__xgafv: string, V1 error format. 536 Allowed values 537 1 - v1 error format 538 2 - v2 error format 539 540Returns: 541 An object of the form: 542 543 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 544 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 545 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 546 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 547 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 548 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 549 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 550 { 551 "code": "A String", # [Output Only] The error type identifier for this error. 552 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 553 "message": "A String", # [Output Only] An optional, human-readable error message. 554 }, 555 ], 556 }, 557 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 558 "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. 559 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 560 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 561 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 562 "name": "A String", # [Output Only] Name of the operation. 563 "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. 564 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 565 "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. 566 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 567 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 568 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 569 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 570 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 571 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 572 "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. 573 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 574 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 575 { 576 "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. 577 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 578 { 579 "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). 580 "value": "A String", # [Output Only] A warning data value corresponding to the key. 581 }, 582 ], 583 "message": "A String", # [Output Only] A human-readable description of the warning code. 584 }, 585 ], 586 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 587}</pre> 588</div> 589 590<div class="method"> 591 <code class="details" id="setCertificateMap">setCertificateMap(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 592 <pre>Changes the Certificate Map for TargetHttpsProxy. 593 594Args: 595 project: string, Project ID for this request. (required) 596 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) 597 body: object, The request body. 598 The object takes the form of: 599 600{ 601 "certificateMap": "A String", # URL of the Certificate Map to associate with this TargetHttpsProxy. 602} 603 604 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). 605 x__xgafv: string, V1 error format. 606 Allowed values 607 1 - v1 error format 608 2 - v2 error format 609 610Returns: 611 An object of the form: 612 613 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 614 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 615 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 616 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 617 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 618 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 619 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 620 { 621 "code": "A String", # [Output Only] The error type identifier for this error. 622 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 623 "message": "A String", # [Output Only] An optional, human-readable error message. 624 }, 625 ], 626 }, 627 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 628 "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. 629 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 630 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 631 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 632 "name": "A String", # [Output Only] Name of the operation. 633 "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. 634 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 635 "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. 636 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 637 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 638 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 639 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 640 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 641 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 642 "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. 643 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 644 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 645 { 646 "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. 647 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 648 { 649 "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). 650 "value": "A String", # [Output Only] A warning data value corresponding to the key. 651 }, 652 ], 653 "message": "A String", # [Output Only] A human-readable description of the warning code. 654 }, 655 ], 656 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 657}</pre> 658</div> 659 660<div class="method"> 661 <code class="details" id="setQuicOverride">setQuicOverride(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 662 <pre>Sets the QUIC override policy for TargetHttpsProxy. 663 664Args: 665 project: string, Project ID for this request. (required) 666 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. (required) 667 body: object, The request body. 668 The object takes the form of: 669 670{ 671 "quicOverride": "A String", # QUIC policy for the TargetHttpsProxy resource. 672} 673 674 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). 675 x__xgafv: string, V1 error format. 676 Allowed values 677 1 - v1 error format 678 2 - v2 error format 679 680Returns: 681 An object of the form: 682 683 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 684 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 685 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 686 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 687 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 688 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 689 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 690 { 691 "code": "A String", # [Output Only] The error type identifier for this error. 692 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 693 "message": "A String", # [Output Only] An optional, human-readable error message. 694 }, 695 ], 696 }, 697 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 698 "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. 699 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 700 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 701 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 702 "name": "A String", # [Output Only] Name of the operation. 703 "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. 704 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 705 "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. 706 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 707 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 708 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 709 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 710 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 711 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 712 "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. 713 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 714 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 715 { 716 "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. 717 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 718 { 719 "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). 720 "value": "A String", # [Output Only] A warning data value corresponding to the key. 721 }, 722 ], 723 "message": "A String", # [Output Only] A human-readable description of the warning code. 724 }, 725 ], 726 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 727}</pre> 728</div> 729 730<div class="method"> 731 <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 732 <pre>Replaces SslCertificates for TargetHttpsProxy. 733 734Args: 735 project: string, Project ID for this request. (required) 736 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required) 737 body: object, The request body. 738 The object takes the form of: 739 740{ 741 "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. 742 "A String", 743 ], 744} 745 746 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). 747 x__xgafv: string, V1 error format. 748 Allowed values 749 1 - v1 error format 750 2 - v2 error format 751 752Returns: 753 An object of the form: 754 755 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 756 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 757 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 758 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 759 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 760 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 761 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 762 { 763 "code": "A String", # [Output Only] The error type identifier for this error. 764 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 765 "message": "A String", # [Output Only] An optional, human-readable error message. 766 }, 767 ], 768 }, 769 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 770 "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. 771 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 772 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 773 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 774 "name": "A String", # [Output Only] Name of the operation. 775 "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. 776 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 777 "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. 778 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 779 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 780 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 781 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 782 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 783 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 784 "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. 785 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 786 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 787 { 788 "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. 789 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 790 { 791 "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). 792 "value": "A String", # [Output Only] A warning data value corresponding to the key. 793 }, 794 ], 795 "message": "A String", # [Output Only] A human-readable description of the warning code. 796 }, 797 ], 798 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 799}</pre> 800</div> 801 802<div class="method"> 803 <code class="details" id="setSslPolicy">setSslPolicy(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 804 <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. 805 806Args: 807 project: string, Project ID for this request. (required) 808 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) 809 body: object, The request body. 810 The object takes the form of: 811 812{ 813 "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. 814} 815 816 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). 817 x__xgafv: string, V1 error format. 818 Allowed values 819 1 - v1 error format 820 2 - v2 error format 821 822Returns: 823 An object of the form: 824 825 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 826 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 827 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 828 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 829 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 830 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 831 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 832 { 833 "code": "A String", # [Output Only] The error type identifier for this error. 834 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 835 "message": "A String", # [Output Only] An optional, human-readable error message. 836 }, 837 ], 838 }, 839 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 840 "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. 841 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 842 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 843 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 844 "name": "A String", # [Output Only] Name of the operation. 845 "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. 846 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 847 "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. 848 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 849 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 850 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 851 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 852 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 853 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 854 "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. 855 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 856 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 857 { 858 "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. 859 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 860 { 861 "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). 862 "value": "A String", # [Output Only] A warning data value corresponding to the key. 863 }, 864 ], 865 "message": "A String", # [Output Only] A human-readable description of the warning code. 866 }, 867 ], 868 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 869}</pre> 870</div> 871 872<div class="method"> 873 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body=None, requestId=None, x__xgafv=None)</code> 874 <pre>Changes the URL map for TargetHttpsProxy. 875 876Args: 877 project: string, Project ID for this request. (required) 878 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required) 879 body: object, The request body. 880 The object takes the form of: 881 882{ 883 "urlMap": "A String", 884} 885 886 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). 887 x__xgafv: string, V1 error format. 888 Allowed values 889 1 - v1 error format 890 2 - v2 error format 891 892Returns: 893 An object of the form: 894 895 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 896 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 897 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 898 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 899 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 900 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 901 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 902 { 903 "code": "A String", # [Output Only] The error type identifier for this error. 904 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 905 "message": "A String", # [Output Only] An optional, human-readable error message. 906 }, 907 ], 908 }, 909 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 910 "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. 911 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 912 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 913 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 914 "name": "A String", # [Output Only] Name of the operation. 915 "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. 916 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 917 "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. 918 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 919 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 920 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 921 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 922 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 923 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 924 "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. 925 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 926 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 927 { 928 "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. 929 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 930 { 931 "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). 932 "value": "A String", # [Output Only] A warning data value corresponding to the key. 933 }, 934 ], 935 "message": "A String", # [Output Only] A human-readable description of the warning code. 936 }, 937 ], 938 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 939}</pre> 940</div> 941 942<div class="method"> 943 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 944 <pre>Returns permissions that a caller has on the specified resource. 945 946Args: 947 project: string, Project ID for this request. (required) 948 resource: string, Name or id of the resource for this request. (required) 949 body: object, The request body. 950 The object takes the form of: 951 952{ 953 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 954 "A String", 955 ], 956} 957 958 x__xgafv: string, V1 error format. 959 Allowed values 960 1 - v1 error format 961 2 - v2 error format 962 963Returns: 964 An object of the form: 965 966 { 967 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 968 "A String", 969 ], 970}</pre> 971</div> 972 973</body></html>