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