1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.backendServices.html">backendServices</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendService, body, requestId=None)</a></code></p> 79 <p class="firstline">Adds the given Signed URL Key to the specified backend service.</p> 80 <p class="toc_element"> 81 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 82 <p class="firstline">Retrieves the list of all BackendService resources, regional and global, available to the specified project.</p> 83 <p class="toc_element"> 84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 85 <p class="firstline">Retrieves the next page of results.</p> 86 <p class="toc_element"> 87 <code><a href="#delete">delete(project, backendService, requestId=None)</a></code></p> 88 <p class="firstline">Deletes the specified BackendService resource.</p> 89 <p class="toc_element"> 90 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None)</a></code></p> 91 <p class="firstline">Deletes the given Signed URL Key from the specified backend service.</p> 92 <p class="toc_element"> 93 <code><a href="#get">get(project, backendService)</a></code></p> 94 <p class="firstline">Returns the specified BackendService resource. Get a list of available backend services by making a list() request.</p> 95 <p class="toc_element"> 96 <code><a href="#getHealth">getHealth(project, backendService, body)</a></code></p> 97 <p class="firstline">Gets the most recent health check results for this BackendService.</p> 98 <p class="toc_element"> 99 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 100 <p class="firstline">Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.</p> 101 <p class="toc_element"> 102 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 103 <p class="firstline">Retrieves the list of BackendService resources available to the specified project.</p> 104 <p class="toc_element"> 105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 106 <p class="firstline">Retrieves the next page of results.</p> 107 <p class="toc_element"> 108 <code><a href="#patch">patch(project, backendService, body, requestId=None)</a></code></p> 109 <p class="firstline">Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.</p> 110 <p class="toc_element"> 111 <code><a href="#setSecurityPolicy">setSecurityPolicy(project, backendService, body, requestId=None)</a></code></p> 112 <p class="firstline">Sets the security policy for the specified backend service.</p> 113 <p class="toc_element"> 114 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 116 <p class="toc_element"> 117 <code><a href="#update">update(project, backendService, body, requestId=None)</a></code></p> 118 <p class="firstline">Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.</p> 119 <h3>Method Details</h3> 120 <div class="method"> 121 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendService, body, requestId=None)</code> 122 <pre>Adds the given Signed URL Key to the specified backend service. 123 124 Args: 125 project: string, Project ID for this request. (required) 126 backendService: string, Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 127 body: object, The request body. (required) 128 The object takes the form of: 129 130 { # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs 131 "keyName": "A String", # Name of the key. 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. 132 "keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string. 133 } 134 135 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 136 137 Returns: 138 An object of the form: 139 140 { # An Operation resource, used to manage asynchronous API requests. 141 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 142 "clientOperationId": "A String", # [Output Only] Reserved for future use. 143 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 144 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 145 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 146 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 147 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 148 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 149 "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. 150 "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. 151 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 152 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 153 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 154 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 155 { 156 "message": "A String", # [Output Only] A human-readable description of the warning code. 157 "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. 158 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 159 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 160 { 161 "value": "A String", # [Output Only] A warning data value corresponding to the key. 162 "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). 163 }, 164 ], 165 }, 166 ], 167 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 168 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 169 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 170 "name": "A String", # [Output Only] Name of the resource. 171 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 172 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 173 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 174 { 175 "message": "A String", # [Output Only] An optional, human-readable error message. 176 "code": "A String", # [Output Only] The error type identifier for this error. 177 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 178 }, 179 ], 180 }, 181 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 182 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 183 "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. 184 }</pre> 185 </div> 186 187 <div class="method"> 188 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 189 <pre>Retrieves the list of all BackendService resources, regional and global, available to the specified project. 190 191 Args: 192 project: string, Name of the project scoping this request. (required) 193 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 194 195 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. 196 197 Currently, only sorting by name or creationTimestamp desc is supported. 198 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) 199 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. 200 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 201 202 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 203 204 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 205 206 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 207 208 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 209 210 Returns: 211 An object of the form: 212 213 { # Contains a list of BackendServicesScopedList. 214 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. 215 "items": { # A map of scoped BackendService lists. 216 "a_key": { # Name of the scope containing this set of BackendServices. 217 "warning": { # Informational warning which replaces the list of backend services when the list is empty. 218 "message": "A String", # [Output Only] A human-readable description of the warning code. 219 "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. 220 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 221 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 222 { 223 "value": "A String", # [Output Only] A warning data value corresponding to the key. 224 "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). 225 }, 226 ], 227 }, 228 "backendServices": [ # List of BackendServices contained in this scope. 229 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. 230 "connectionDraining": { # Message containing connection draining configuration. 231 "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started). 232 }, 233 "failoverRatio": 3.14, # The value of the field must be in [0, 1]. If set, 'backends[].failover' must be set. They together define the fallback behavior of the primary backend: if the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. 234 # 235 # In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. 236 # 237 # This field is only used with l4 load balancing. 238 "protocol": "A String", # The protocol this BackendService uses to communicate with backends. 239 # 240 # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. 241 # 242 # For internal load balancing, the possible values are TCP and UDP, and the default is TCP. 243 "loadBalancingScheme": "A String", 244 "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. 245 # 246 # For internal load balancing, a URL to a HealthCheck resource must be specified instead. 247 "A String", 248 ], 249 "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. 250 # 251 # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. 252 # 253 # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. 254 # 255 # When the protocol is UDP, this field is not used. 256 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 257 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 258 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. 259 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend service. 260 "A String", 261 ], 262 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 263 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 264 "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 265 "includeHost": True or False, # If true, requests to different hosts will be cached separately. 266 "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 267 "A String", 268 ], 269 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 270 "A String", 271 ], 272 "includeProtocol": True or False, # If true, http and https requests will be cached separately. 273 }, 274 }, 275 "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService. 276 # 277 # When the load balancing scheme is INTERNAL, this field is not used. 278 "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. 279 # 280 # When the load balancing scheme is INTERNAL, this field is not used. 281 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. 282 # 283 # This cannot be used for internal load balancing. 284 "backends": [ # The list of backends that serve this BackendService. 285 { # Message containing information of one individual backend. 286 "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. 287 # 288 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL. 289 # 290 # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService. 291 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 292 "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. 293 # 294 # This cannot be used for internal load balancing. 295 "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 296 "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 297 # 298 # This cannot be used for internal load balancing. 299 "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 300 # 301 # This cannot be used for internal load balancing. 302 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. 303 # 304 # This cannot be used for internal load balancing. 305 "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 306 # 307 # This cannot be used for internal load balancing. 308 "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 309 # 310 # This cannot be used for internal load balancing. 311 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). 312 # 313 # This cannot be used for internal load balancing. 314 }, 315 ], 316 "iap": { # Identity-Aware Proxy 317 "oauth2ClientId": "A String", 318 "enabled": True or False, 319 "oauth2ClientSecret": "A String", 320 "oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above. 321 }, 322 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 323 "customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests. 324 "A String", 325 ], 326 "securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service. 327 "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. 328 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. 329 # 330 # When the load balancing scheme is INTERNAL, this field is not used. 331 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services. 332 "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. 333 "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 334 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. 335 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 336 }, 337 ], 338 }, 339 }, 340 "kind": "compute#backendServiceAggregatedList", # Type of resource. 341 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 342 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 343 }</pre> 344 </div> 345 346 <div class="method"> 347 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 348 <pre>Retrieves the next page of results. 349 350 Args: 351 previous_request: The request for the previous page. (required) 352 previous_response: The response from the request for the previous page. (required) 353 354 Returns: 355 A request object that you can call 'execute()' on to request the next 356 page. Returns None if there are no more items in the collection. 357 </pre> 358 </div> 359 360 <div class="method"> 361 <code class="details" id="delete">delete(project, backendService, requestId=None)</code> 362 <pre>Deletes the specified BackendService resource. 363 364 Args: 365 project: string, Project ID for this request. (required) 366 backendService: string, Name of the BackendService resource to delete. (required) 367 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 368 369 Returns: 370 An object of the form: 371 372 { # An Operation resource, used to manage asynchronous API requests. 373 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 374 "clientOperationId": "A String", # [Output Only] Reserved for future use. 375 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 376 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 377 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 378 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 379 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 380 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 381 "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. 382 "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. 383 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 384 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 385 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 386 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 387 { 388 "message": "A String", # [Output Only] A human-readable description of the warning code. 389 "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. 390 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 391 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 392 { 393 "value": "A String", # [Output Only] A warning data value corresponding to the key. 394 "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). 395 }, 396 ], 397 }, 398 ], 399 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 400 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 401 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 402 "name": "A String", # [Output Only] Name of the resource. 403 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 404 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 405 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 406 { 407 "message": "A String", # [Output Only] An optional, human-readable error message. 408 "code": "A String", # [Output Only] The error type identifier for this error. 409 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 410 }, 411 ], 412 }, 413 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 414 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 415 "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. 416 }</pre> 417 </div> 418 419 <div class="method"> 420 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None)</code> 421 <pre>Deletes the given Signed URL Key from the specified backend service. 422 423 Args: 424 project: string, Project ID for this request. (required) 425 backendService: string, Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required) 426 keyName: string, The name of the Signed URL Key to delete. (required) 427 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 428 429 Returns: 430 An object of the form: 431 432 { # An Operation resource, used to manage asynchronous API requests. 433 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 434 "clientOperationId": "A String", # [Output Only] Reserved for future use. 435 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 436 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 437 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 438 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 439 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 440 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 441 "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. 442 "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. 443 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 444 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 445 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 446 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 447 { 448 "message": "A String", # [Output Only] A human-readable description of the warning code. 449 "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. 450 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 451 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 452 { 453 "value": "A String", # [Output Only] A warning data value corresponding to the key. 454 "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). 455 }, 456 ], 457 }, 458 ], 459 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 460 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 461 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 462 "name": "A String", # [Output Only] Name of the resource. 463 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 464 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 465 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 466 { 467 "message": "A String", # [Output Only] An optional, human-readable error message. 468 "code": "A String", # [Output Only] The error type identifier for this error. 469 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 470 }, 471 ], 472 }, 473 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 474 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 475 "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. 476 }</pre> 477 </div> 478 479 <div class="method"> 480 <code class="details" id="get">get(project, backendService)</code> 481 <pre>Returns the specified BackendService resource. Get a list of available backend services by making a list() request. 482 483 Args: 484 project: string, Project ID for this request. (required) 485 backendService: string, Name of the BackendService resource to return. (required) 486 487 Returns: 488 An object of the form: 489 490 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. 491 "connectionDraining": { # Message containing connection draining configuration. 492 "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started). 493 }, 494 "failoverRatio": 3.14, # The value of the field must be in [0, 1]. If set, 'backends[].failover' must be set. They together define the fallback behavior of the primary backend: if the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. 495 # 496 # In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. 497 # 498 # This field is only used with l4 load balancing. 499 "protocol": "A String", # The protocol this BackendService uses to communicate with backends. 500 # 501 # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. 502 # 503 # For internal load balancing, the possible values are TCP and UDP, and the default is TCP. 504 "loadBalancingScheme": "A String", 505 "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. 506 # 507 # For internal load balancing, a URL to a HealthCheck resource must be specified instead. 508 "A String", 509 ], 510 "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. 511 # 512 # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. 513 # 514 # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. 515 # 516 # When the protocol is UDP, this field is not used. 517 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 518 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 519 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. 520 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend service. 521 "A String", 522 ], 523 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 524 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 525 "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 526 "includeHost": True or False, # If true, requests to different hosts will be cached separately. 527 "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 528 "A String", 529 ], 530 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 531 "A String", 532 ], 533 "includeProtocol": True or False, # If true, http and https requests will be cached separately. 534 }, 535 }, 536 "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService. 537 # 538 # When the load balancing scheme is INTERNAL, this field is not used. 539 "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. 540 # 541 # When the load balancing scheme is INTERNAL, this field is not used. 542 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. 543 # 544 # This cannot be used for internal load balancing. 545 "backends": [ # The list of backends that serve this BackendService. 546 { # Message containing information of one individual backend. 547 "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. 548 # 549 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL. 550 # 551 # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService. 552 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 553 "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. 554 # 555 # This cannot be used for internal load balancing. 556 "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 557 "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 558 # 559 # This cannot be used for internal load balancing. 560 "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 561 # 562 # This cannot be used for internal load balancing. 563 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. 564 # 565 # This cannot be used for internal load balancing. 566 "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 567 # 568 # This cannot be used for internal load balancing. 569 "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 570 # 571 # This cannot be used for internal load balancing. 572 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). 573 # 574 # This cannot be used for internal load balancing. 575 }, 576 ], 577 "iap": { # Identity-Aware Proxy 578 "oauth2ClientId": "A String", 579 "enabled": True or False, 580 "oauth2ClientSecret": "A String", 581 "oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above. 582 }, 583 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 584 "customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests. 585 "A String", 586 ], 587 "securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service. 588 "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. 589 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. 590 # 591 # When the load balancing scheme is INTERNAL, this field is not used. 592 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services. 593 "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. 594 "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 595 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. 596 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 597 }</pre> 598 </div> 599 600 <div class="method"> 601 <code class="details" id="getHealth">getHealth(project, backendService, body)</code> 602 <pre>Gets the most recent health check results for this BackendService. 603 604 Args: 605 project: string, A parameter (required) 606 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required) 607 body: object, The request body. (required) 608 The object takes the form of: 609 610 { 611 "group": "A String", # A URI referencing one of the instance groups listed in the backend service. 612 } 613 614 615 Returns: 616 An object of the form: 617 618 { 619 "kind": "compute#backendServiceGroupHealth", # [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. 620 "healthStatus": [ 621 { 622 "instance": "A String", # URL of the instance resource. 623 "healthState": "A String", # Health state of the instance. 624 "ipAddress": "A String", # The IP address represented by this resource. 625 "port": 42, # The port on the instance. 626 }, 627 ], 628 }</pre> 629 </div> 630 631 <div class="method"> 632 <code class="details" id="insert">insert(project, body, requestId=None)</code> 633 <pre>Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information. 634 635 Args: 636 project: string, Project ID for this request. (required) 637 body: object, The request body. (required) 638 The object takes the form of: 639 640 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. 641 "connectionDraining": { # Message containing connection draining configuration. 642 "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started). 643 }, 644 "failoverRatio": 3.14, # The value of the field must be in [0, 1]. If set, 'backends[].failover' must be set. They together define the fallback behavior of the primary backend: if the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. 645 # 646 # In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. 647 # 648 # This field is only used with l4 load balancing. 649 "protocol": "A String", # The protocol this BackendService uses to communicate with backends. 650 # 651 # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. 652 # 653 # For internal load balancing, the possible values are TCP and UDP, and the default is TCP. 654 "loadBalancingScheme": "A String", 655 "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. 656 # 657 # For internal load balancing, a URL to a HealthCheck resource must be specified instead. 658 "A String", 659 ], 660 "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. 661 # 662 # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. 663 # 664 # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. 665 # 666 # When the protocol is UDP, this field is not used. 667 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 668 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 669 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. 670 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend service. 671 "A String", 672 ], 673 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 674 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 675 "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 676 "includeHost": True or False, # If true, requests to different hosts will be cached separately. 677 "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 678 "A String", 679 ], 680 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 681 "A String", 682 ], 683 "includeProtocol": True or False, # If true, http and https requests will be cached separately. 684 }, 685 }, 686 "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService. 687 # 688 # When the load balancing scheme is INTERNAL, this field is not used. 689 "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. 690 # 691 # When the load balancing scheme is INTERNAL, this field is not used. 692 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. 693 # 694 # This cannot be used for internal load balancing. 695 "backends": [ # The list of backends that serve this BackendService. 696 { # Message containing information of one individual backend. 697 "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. 698 # 699 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL. 700 # 701 # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService. 702 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 703 "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. 704 # 705 # This cannot be used for internal load balancing. 706 "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 707 "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 708 # 709 # This cannot be used for internal load balancing. 710 "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 711 # 712 # This cannot be used for internal load balancing. 713 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. 714 # 715 # This cannot be used for internal load balancing. 716 "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 717 # 718 # This cannot be used for internal load balancing. 719 "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 720 # 721 # This cannot be used for internal load balancing. 722 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). 723 # 724 # This cannot be used for internal load balancing. 725 }, 726 ], 727 "iap": { # Identity-Aware Proxy 728 "oauth2ClientId": "A String", 729 "enabled": True or False, 730 "oauth2ClientSecret": "A String", 731 "oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above. 732 }, 733 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 734 "customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests. 735 "A String", 736 ], 737 "securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service. 738 "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. 739 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. 740 # 741 # When the load balancing scheme is INTERNAL, this field is not used. 742 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services. 743 "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. 744 "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 745 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. 746 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 747 } 748 749 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 750 751 Returns: 752 An object of the form: 753 754 { # An Operation resource, used to manage asynchronous API requests. 755 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 756 "clientOperationId": "A String", # [Output Only] Reserved for future use. 757 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 758 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 759 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 760 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 761 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 762 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 763 "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. 764 "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. 765 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 766 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 767 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 768 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 769 { 770 "message": "A String", # [Output Only] A human-readable description of the warning code. 771 "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. 772 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 773 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 774 { 775 "value": "A String", # [Output Only] A warning data value corresponding to the key. 776 "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). 777 }, 778 ], 779 }, 780 ], 781 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 782 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 783 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 784 "name": "A String", # [Output Only] Name of the resource. 785 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 786 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 787 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 788 { 789 "message": "A String", # [Output Only] An optional, human-readable error message. 790 "code": "A String", # [Output Only] The error type identifier for this error. 791 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 792 }, 793 ], 794 }, 795 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 796 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 797 "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. 798 }</pre> 799 </div> 800 801 <div class="method"> 802 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 803 <pre>Retrieves the list of BackendService resources available to the specified project. 804 805 Args: 806 project: string, Project ID for this request. (required) 807 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 808 809 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. 810 811 Currently, only sorting by name or creationTimestamp desc is supported. 812 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) 813 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. 814 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 815 816 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 817 818 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 819 820 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 821 822 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 823 824 Returns: 825 An object of the form: 826 827 { # Contains a list of BackendService resources. 828 "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. 829 "items": [ # A list of BackendService resources. 830 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. 831 "connectionDraining": { # Message containing connection draining configuration. 832 "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started). 833 }, 834 "failoverRatio": 3.14, # The value of the field must be in [0, 1]. If set, 'backends[].failover' must be set. They together define the fallback behavior of the primary backend: if the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. 835 # 836 # In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. 837 # 838 # This field is only used with l4 load balancing. 839 "protocol": "A String", # The protocol this BackendService uses to communicate with backends. 840 # 841 # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. 842 # 843 # For internal load balancing, the possible values are TCP and UDP, and the default is TCP. 844 "loadBalancingScheme": "A String", 845 "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. 846 # 847 # For internal load balancing, a URL to a HealthCheck resource must be specified instead. 848 "A String", 849 ], 850 "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. 851 # 852 # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. 853 # 854 # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. 855 # 856 # When the protocol is UDP, this field is not used. 857 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 858 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 859 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. 860 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend service. 861 "A String", 862 ], 863 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 864 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 865 "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 866 "includeHost": True or False, # If true, requests to different hosts will be cached separately. 867 "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 868 "A String", 869 ], 870 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 871 "A String", 872 ], 873 "includeProtocol": True or False, # If true, http and https requests will be cached separately. 874 }, 875 }, 876 "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService. 877 # 878 # When the load balancing scheme is INTERNAL, this field is not used. 879 "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. 880 # 881 # When the load balancing scheme is INTERNAL, this field is not used. 882 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. 883 # 884 # This cannot be used for internal load balancing. 885 "backends": [ # The list of backends that serve this BackendService. 886 { # Message containing information of one individual backend. 887 "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. 888 # 889 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL. 890 # 891 # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService. 892 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 893 "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. 894 # 895 # This cannot be used for internal load balancing. 896 "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 897 "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 898 # 899 # This cannot be used for internal load balancing. 900 "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 901 # 902 # This cannot be used for internal load balancing. 903 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. 904 # 905 # This cannot be used for internal load balancing. 906 "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 907 # 908 # This cannot be used for internal load balancing. 909 "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 910 # 911 # This cannot be used for internal load balancing. 912 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). 913 # 914 # This cannot be used for internal load balancing. 915 }, 916 ], 917 "iap": { # Identity-Aware Proxy 918 "oauth2ClientId": "A String", 919 "enabled": True or False, 920 "oauth2ClientSecret": "A String", 921 "oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above. 922 }, 923 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 924 "customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests. 925 "A String", 926 ], 927 "securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service. 928 "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. 929 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. 930 # 931 # When the load balancing scheme is INTERNAL, this field is not used. 932 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services. 933 "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. 934 "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 935 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. 936 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 937 }, 938 ], 939 "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services. 940 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 941 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 942 }</pre> 943 </div> 944 945 <div class="method"> 946 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 947 <pre>Retrieves the next page of results. 948 949 Args: 950 previous_request: The request for the previous page. (required) 951 previous_response: The response from the request for the previous page. (required) 952 953 Returns: 954 A request object that you can call 'execute()' on to request the next 955 page. Returns None if there are no more items in the collection. 956 </pre> 957 </div> 958 959 <div class="method"> 960 <code class="details" id="patch">patch(project, backendService, body, requestId=None)</code> 961 <pre>Patches the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics. 962 963 Args: 964 project: string, Project ID for this request. (required) 965 backendService: string, Name of the BackendService resource to patch. (required) 966 body: object, The request body. (required) 967 The object takes the form of: 968 969 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. 970 "connectionDraining": { # Message containing connection draining configuration. 971 "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started). 972 }, 973 "failoverRatio": 3.14, # The value of the field must be in [0, 1]. If set, 'backends[].failover' must be set. They together define the fallback behavior of the primary backend: if the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. 974 # 975 # In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. 976 # 977 # This field is only used with l4 load balancing. 978 "protocol": "A String", # The protocol this BackendService uses to communicate with backends. 979 # 980 # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. 981 # 982 # For internal load balancing, the possible values are TCP and UDP, and the default is TCP. 983 "loadBalancingScheme": "A String", 984 "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. 985 # 986 # For internal load balancing, a URL to a HealthCheck resource must be specified instead. 987 "A String", 988 ], 989 "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. 990 # 991 # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. 992 # 993 # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. 994 # 995 # When the protocol is UDP, this field is not used. 996 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 997 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 998 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. 999 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend service. 1000 "A String", 1001 ], 1002 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 1003 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 1004 "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 1005 "includeHost": True or False, # If true, requests to different hosts will be cached separately. 1006 "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 1007 "A String", 1008 ], 1009 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 1010 "A String", 1011 ], 1012 "includeProtocol": True or False, # If true, http and https requests will be cached separately. 1013 }, 1014 }, 1015 "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService. 1016 # 1017 # When the load balancing scheme is INTERNAL, this field is not used. 1018 "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. 1019 # 1020 # When the load balancing scheme is INTERNAL, this field is not used. 1021 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. 1022 # 1023 # This cannot be used for internal load balancing. 1024 "backends": [ # The list of backends that serve this BackendService. 1025 { # Message containing information of one individual backend. 1026 "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. 1027 # 1028 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL. 1029 # 1030 # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService. 1031 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1032 "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. 1033 # 1034 # This cannot be used for internal load balancing. 1035 "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 1036 "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 1037 # 1038 # This cannot be used for internal load balancing. 1039 "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 1040 # 1041 # This cannot be used for internal load balancing. 1042 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. 1043 # 1044 # This cannot be used for internal load balancing. 1045 "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 1046 # 1047 # This cannot be used for internal load balancing. 1048 "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 1049 # 1050 # This cannot be used for internal load balancing. 1051 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). 1052 # 1053 # This cannot be used for internal load balancing. 1054 }, 1055 ], 1056 "iap": { # Identity-Aware Proxy 1057 "oauth2ClientId": "A String", 1058 "enabled": True or False, 1059 "oauth2ClientSecret": "A String", 1060 "oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above. 1061 }, 1062 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1063 "customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests. 1064 "A String", 1065 ], 1066 "securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service. 1067 "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. 1068 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. 1069 # 1070 # When the load balancing scheme is INTERNAL, this field is not used. 1071 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services. 1072 "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. 1073 "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 1074 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. 1075 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1076 } 1077 1078 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 1079 1080 Returns: 1081 An object of the form: 1082 1083 { # An Operation resource, used to manage asynchronous API requests. 1084 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1085 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1086 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1087 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1088 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1089 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1090 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1091 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1092 "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. 1093 "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. 1094 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1095 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1096 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1097 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1098 { 1099 "message": "A String", # [Output Only] A human-readable description of the warning code. 1100 "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. 1101 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1102 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1103 { 1104 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1105 "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). 1106 }, 1107 ], 1108 }, 1109 ], 1110 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1111 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1112 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1113 "name": "A String", # [Output Only] Name of the resource. 1114 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1115 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1116 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1117 { 1118 "message": "A String", # [Output Only] An optional, human-readable error message. 1119 "code": "A String", # [Output Only] The error type identifier for this error. 1120 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1121 }, 1122 ], 1123 }, 1124 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1125 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1126 "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. 1127 }</pre> 1128 </div> 1129 1130 <div class="method"> 1131 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, backendService, body, requestId=None)</code> 1132 <pre>Sets the security policy for the specified backend service. 1133 1134 Args: 1135 project: string, Project ID for this request. (required) 1136 backendService: string, Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. (required) 1137 body: object, The request body. (required) 1138 The object takes the form of: 1139 1140 { 1141 "securityPolicy": "A String", 1142 } 1143 1144 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 1145 1146 Returns: 1147 An object of the form: 1148 1149 { # An Operation resource, used to manage asynchronous API requests. 1150 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1151 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1152 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1153 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1154 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1155 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1156 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1157 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1158 "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. 1159 "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. 1160 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1161 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1162 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1163 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1164 { 1165 "message": "A String", # [Output Only] A human-readable description of the warning code. 1166 "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. 1167 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1168 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1169 { 1170 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1171 "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). 1172 }, 1173 ], 1174 }, 1175 ], 1176 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1177 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1178 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1179 "name": "A String", # [Output Only] Name of the resource. 1180 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1181 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1182 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1183 { 1184 "message": "A String", # [Output Only] An optional, human-readable error message. 1185 "code": "A String", # [Output Only] The error type identifier for this error. 1186 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1187 }, 1188 ], 1189 }, 1190 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1191 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1192 "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. 1193 }</pre> 1194 </div> 1195 1196 <div class="method"> 1197 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1198 <pre>Returns permissions that a caller has on the specified resource. 1199 1200 Args: 1201 project: string, Project ID for this request. (required) 1202 resource: string, Name of the resource for this request. (required) 1203 body: object, The request body. (required) 1204 The object takes the form of: 1205 1206 { 1207 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1208 "A String", 1209 ], 1210 } 1211 1212 1213 Returns: 1214 An object of the form: 1215 1216 { 1217 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1218 "A String", 1219 ], 1220 }</pre> 1221 </div> 1222 1223 <div class="method"> 1224 <code class="details" id="update">update(project, backendService, body, requestId=None)</code> 1225 <pre>Updates the specified BackendService resource with the data included in the request. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. 1226 1227 Args: 1228 project: string, Project ID for this request. (required) 1229 backendService: string, Name of the BackendService resource to update. (required) 1230 body: object, The request body. (required) 1231 The object takes the form of: 1232 1233 { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. 1234 "connectionDraining": { # Message containing connection draining configuration. 1235 "drainingTimeoutSec": 42, # Time for which instance will be drained (not accept new connections, but still work to finish started). 1236 }, 1237 "failoverRatio": 3.14, # The value of the field must be in [0, 1]. If set, 'backends[].failover' must be set. They together define the fallback behavior of the primary backend: if the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. 1238 # 1239 # In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. 1240 # 1241 # This field is only used with l4 load balancing. 1242 "protocol": "A String", # The protocol this BackendService uses to communicate with backends. 1243 # 1244 # Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. 1245 # 1246 # For internal load balancing, the possible values are TCP and UDP, and the default is TCP. 1247 "loadBalancingScheme": "A String", 1248 "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. 1249 # 1250 # For internal load balancing, a URL to a HealthCheck resource must be specified instead. 1251 "A String", 1252 ], 1253 "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. 1254 # 1255 # When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. 1256 # 1257 # When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. 1258 # 1259 # When the protocol is UDP, this field is not used. 1260 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 1261 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1262 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. 1263 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend service. 1264 "A String", 1265 ], 1266 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this backend had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. 1267 "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cloud CDN. # The CacheKeyPolicy for this CdnPolicy. 1268 "includeQueryString": True or False, # If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely. 1269 "includeHost": True or False, # If true, requests to different hosts will be cached separately. 1270 "queryStringBlacklist": [ # Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 1271 "A String", 1272 ], 1273 "queryStringWhitelist": [ # Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters. 1274 "A String", 1275 ], 1276 "includeProtocol": True or False, # If true, http and https requests will be cached separately. 1277 }, 1278 }, 1279 "enableCDN": True or False, # If true, enable Cloud CDN for this BackendService. 1280 # 1281 # When the load balancing scheme is INTERNAL, this field is not used. 1282 "affinityCookieTtlSec": 42, # Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. 1283 # 1284 # When the load balancing scheme is INTERNAL, this field is not used. 1285 "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. 1286 # 1287 # This cannot be used for internal load balancing. 1288 "backends": [ # The list of backends that serve this BackendService. 1289 { # Message containing information of one individual backend. 1290 "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. 1291 # 1292 # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL. 1293 # 1294 # When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService. 1295 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1296 "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. 1297 # 1298 # This cannot be used for internal load balancing. 1299 "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. 1300 "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 1301 # 1302 # This cannot be used for internal load balancing. 1303 "maxConnectionsPerInstance": 42, # The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 1304 # 1305 # This cannot be used for internal load balancing. 1306 "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. 1307 # 1308 # This cannot be used for internal load balancing. 1309 "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. 1310 # 1311 # This cannot be used for internal load balancing. 1312 "maxConnections": 42, # The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. 1313 # 1314 # This cannot be used for internal load balancing. 1315 "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). 1316 # 1317 # This cannot be used for internal load balancing. 1318 }, 1319 ], 1320 "iap": { # Identity-Aware Proxy 1321 "oauth2ClientId": "A String", 1322 "enabled": True or False, 1323 "oauth2ClientSecret": "A String", 1324 "oauth2ClientSecretSha256": "A String", # [Output Only] SHA256 hash value for the field oauth2_client_secret above. 1325 }, 1326 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 1327 "customRequestHeaders": [ # Headers that the HTTP/S load balancer should add to proxied requests. 1328 "A String", 1329 ], 1330 "securityPolicy": "A String", # [Output Only] The resource URL for the security policy associated with this backend service. 1331 "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 BackendService. An up-to-date fingerprint must be provided in order to update the BackendService. 1332 "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. 1333 # 1334 # When the load balancing scheme is INTERNAL, this field is not used. 1335 "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services. 1336 "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. 1337 "region": "A String", # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. 1338 "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. 1339 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1340 } 1341 1342 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 1343 1344 Returns: 1345 An object of the form: 1346 1347 { # An Operation resource, used to manage asynchronous API requests. 1348 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1349 "clientOperationId": "A String", # [Output Only] Reserved for future use. 1350 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1351 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1352 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 1353 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1354 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1355 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1356 "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. 1357 "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. 1358 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1359 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1360 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1361 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1362 { 1363 "message": "A String", # [Output Only] A human-readable description of the warning code. 1364 "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. 1365 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1366 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1367 { 1368 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1369 "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). 1370 }, 1371 ], 1372 }, 1373 ], 1374 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 1375 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1376 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1377 "name": "A String", # [Output Only] Name of the resource. 1378 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 1379 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1380 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1381 { 1382 "message": "A String", # [Output Only] An optional, human-readable error message. 1383 "code": "A String", # [Output Only] The error type identifier for this error. 1384 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1385 }, 1386 ], 1387 }, 1388 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1389 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1390 "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. 1391 }</pre> 1392 </div> 1393 1394 </body></html>
