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