| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.backendServices.html">backendServices</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, backendService)</a></code></p> |
| <p class="firstline">Deletes the specified BackendService resource.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, backendService)</a></code></p> |
| <p class="firstline">Returns the specified BackendService resource.</p> |
| <p class="toc_element"> |
| <code><a href="#getHealth">getHealth(project, backendService, body)</a></code></p> |
| <p class="firstline">Gets the most recent health check results for this BackendService.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, body)</a></code></p> |
| <p class="firstline">Creates a BackendService resource in the specified project using the data included in the request.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p> |
| <p class="firstline">Retrieves the list of BackendService resources available to the specified project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(project, backendService, body)</a></code></p> |
| <p class="firstline">Update the entire content of the BackendService resource. This method supports patch semantics.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(project, backendService, body)</a></code></p> |
| <p class="firstline">Update the entire content of the BackendService resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(project, backendService)</code> |
| <pre>Deletes the specified BackendService resource. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| backendService: string, Name of the BackendService resource to delete. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # An operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only). |
| "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "zone": "A String", # URL of the zone where the operation resides (output only). |
| "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only). |
| "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only). |
| "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only). |
| "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only). |
| "statusMessage": "A String", # An optional textual description of the current status of the operation (output only). |
| "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only). |
| "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only). |
| "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only). |
| { |
| "message": "A String", # Optional human-readable details for this warning. |
| "code": "A String", # The warning type identifier for this warning. |
| "data": [ # Metadata for this warning in 'key: value' format. |
| { |
| "value": "A String", # A warning data value corresponding to the key. |
| "key": "A String", # A key for the warning data. |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # User who requested the operation, for example "user@example.com" (output only). |
| "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only). |
| "kind": "compute#operation", # Type of the resource. |
| "name": "A String", # Name of the resource (output only). |
| "region": "A String", # URL of the region where the operation resides (output only). |
| "error": { # If errors occurred during processing of this operation, this field will be populated (output only). |
| "errors": [ # The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # An optional, human-readable error message. |
| "code": "A String", # The error type identifier for this error. |
| "location": "A String", # Indicates the field in the request which caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "targetLink": "A String", # URL of the resource the operation is mutating (output only). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, backendService)</code> |
| <pre>Returns the specified BackendService resource. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| backendService: string, Name of the BackendService resource to return. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity. |
| "kind": "compute#backendService", # Type of the resource. |
| "protocol": "A String", |
| "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
| "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. |
| "port": 42, # The TCP port to connect on the backend. The default value is 80. |
| "backends": [ # The list of backends that serve this BackendService. |
| { # Message containing information of one individual backend. |
| "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource. |
| "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created. |
| "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, 1]. |
| "maxRatePerInstance": 3.14, # The max RPS that a single backed 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. |
| "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6]. |
| "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. |
| "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION. |
| }, |
| ], |
| "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. |
| "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required. |
| "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. |
| "A String", |
| ], |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getHealth">getHealth(project, backendService, body)</code> |
| <pre>Gets the most recent health check results for this BackendService. |
| |
| Args: |
| project: string, A parameter (required) |
| backendService: string, Name of the BackendService resource to which the queried instance belongs. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { |
| "group": "A String", # A URI referencing one of the resource views listed in the backend service. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "compute#backendServiceGroupHealth", # Type of resource. |
| "healthStatus": [ |
| { |
| "instance": "A String", # URL of the instance resource. |
| "healthState": "A String", # Health state of the instance. |
| "ipAddress": "A String", # The IP address represented by this resource. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, body)</code> |
| <pre>Creates a BackendService resource in the specified project using the data included in the request. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity. |
| "kind": "compute#backendService", # Type of the resource. |
| "protocol": "A String", |
| "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
| "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. |
| "port": 42, # The TCP port to connect on the backend. The default value is 80. |
| "backends": [ # The list of backends that serve this BackendService. |
| { # Message containing information of one individual backend. |
| "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource. |
| "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created. |
| "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, 1]. |
| "maxRatePerInstance": 3.14, # The max RPS that a single backed 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. |
| "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6]. |
| "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. |
| "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION. |
| }, |
| ], |
| "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. |
| "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required. |
| "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. |
| "A String", |
| ], |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # An operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only). |
| "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "zone": "A String", # URL of the zone where the operation resides (output only). |
| "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only). |
| "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only). |
| "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only). |
| "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only). |
| "statusMessage": "A String", # An optional textual description of the current status of the operation (output only). |
| "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only). |
| "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only). |
| "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only). |
| { |
| "message": "A String", # Optional human-readable details for this warning. |
| "code": "A String", # The warning type identifier for this warning. |
| "data": [ # Metadata for this warning in 'key: value' format. |
| { |
| "value": "A String", # A warning data value corresponding to the key. |
| "key": "A String", # A key for the warning data. |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # User who requested the operation, for example "user@example.com" (output only). |
| "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only). |
| "kind": "compute#operation", # Type of the resource. |
| "name": "A String", # Name of the resource (output only). |
| "region": "A String", # URL of the region where the operation resides (output only). |
| "error": { # If errors occurred during processing of this operation, this field will be populated (output only). |
| "errors": [ # The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # An optional, human-readable error message. |
| "code": "A String", # The error type identifier for this error. |
| "location": "A String", # Indicates the field in the request which caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "targetLink": "A String", # URL of the resource the operation is mutating (output only). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code> |
| <pre>Retrieves the list of BackendService resources available to the specified project. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500. |
| pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. |
| filter: string, Optional. Filter expression for filtering listed resources. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of BackendService resources. |
| "nextPageToken": "A String", # A token used to continue a truncated list request (output only). |
| "items": [ # The BackendService resources. |
| { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity. |
| "kind": "compute#backendService", # Type of the resource. |
| "protocol": "A String", |
| "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
| "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. |
| "port": 42, # The TCP port to connect on the backend. The default value is 80. |
| "backends": [ # The list of backends that serve this BackendService. |
| { # Message containing information of one individual backend. |
| "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource. |
| "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created. |
| "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, 1]. |
| "maxRatePerInstance": 3.14, # The max RPS that a single backed 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. |
| "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6]. |
| "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. |
| "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION. |
| }, |
| ], |
| "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. |
| "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required. |
| "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. |
| "A String", |
| ], |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "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. |
| }, |
| ], |
| "kind": "compute#backendServiceList", # Type of resource. |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for this resource (output only). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(project, backendService, body)</code> |
| <pre>Update the entire content of the BackendService resource. This method supports patch semantics. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| backendService: string, Name of the BackendService resource to update. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity. |
| "kind": "compute#backendService", # Type of the resource. |
| "protocol": "A String", |
| "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
| "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. |
| "port": 42, # The TCP port to connect on the backend. The default value is 80. |
| "backends": [ # The list of backends that serve this BackendService. |
| { # Message containing information of one individual backend. |
| "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource. |
| "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created. |
| "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, 1]. |
| "maxRatePerInstance": 3.14, # The max RPS that a single backed 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. |
| "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6]. |
| "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. |
| "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION. |
| }, |
| ], |
| "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. |
| "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required. |
| "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. |
| "A String", |
| ], |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # An operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only). |
| "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "zone": "A String", # URL of the zone where the operation resides (output only). |
| "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only). |
| "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only). |
| "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only). |
| "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only). |
| "statusMessage": "A String", # An optional textual description of the current status of the operation (output only). |
| "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only). |
| "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only). |
| "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only). |
| { |
| "message": "A String", # Optional human-readable details for this warning. |
| "code": "A String", # The warning type identifier for this warning. |
| "data": [ # Metadata for this warning in 'key: value' format. |
| { |
| "value": "A String", # A warning data value corresponding to the key. |
| "key": "A String", # A key for the warning data. |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # User who requested the operation, for example "user@example.com" (output only). |
| "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only). |
| "kind": "compute#operation", # Type of the resource. |
| "name": "A String", # Name of the resource (output only). |
| "region": "A String", # URL of the region where the operation resides (output only). |
| "error": { # If errors occurred during processing of this operation, this field will be populated (output only). |
| "errors": [ # The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # An optional, human-readable error message. |
| "code": "A String", # The error type identifier for this error. |
| "location": "A String", # Indicates the field in the request which caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "targetLink": "A String", # URL of the resource the operation is mutating (output only). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(project, backendService, body)</code> |
| <pre>Update the entire content of the BackendService resource. |
| |
| Args: |
| project: string, Name of the project scoping this request. (required) |
| backendService: string, Name of the BackendService resource to update. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # A BackendService resource. This resource defines a group of backend VMs together with their serving capacity. |
| "kind": "compute#backendService", # Type of the resource. |
| "protocol": "A String", |
| "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. |
| "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. |
| "port": 42, # The TCP port to connect on the backend. The default value is 80. |
| "backends": [ # The list of backends that serve this BackendService. |
| { # Message containing information of one individual backend. |
| "group": "A String", # URL of a zonal Cloud Resource View resource. This resource view defines the list of instances that serve traffic. Member virtual machine instances from each resource view must live in the same zone as the resource view itself. No two backends in a backend service are allowed to use same Resource View resource. |
| "description": "A String", # An optional textual description of the resource, which is provided by the client when the resource is created. |
| "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, 1]. |
| "maxRatePerInstance": 3.14, # The max RPS that a single backed 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. |
| "capacityScaler": 3.14, # The multiplier (a value between 0 and 1e6) of the max capacity (CPU or RPS, depending on 'balancingMode') the group should serve up to. 0 means the group is totally drained. Default value is 1. Valid range is [0, 1e6]. |
| "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. |
| "balancingMode": "A String", # The balancing mode of this backend, default is UTILIZATION. |
| }, |
| ], |
| "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. |
| "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required. |
| "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. |
| "A String", |
| ], |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # An operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # Unique target id which identifies a particular incarnation of the target (output only). |
| "clientOperationId": "A String", # An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only). |
| "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only). |
| "id": "A String", # Unique identifier for the resource; defined by the server (output only). |
| "zone": "A String", # URL of the zone where the operation resides (output only). |
| "operationType": "A String", # Type of the operation. Examples include "insert", "update", and "delete" (output only). |
| "httpErrorMessage": "A String", # If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only). |
| "progress": 42, # 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only). |
| "httpErrorStatusCode": 42, # If operation fails, the HTTP error status code returned, e.g. 404. (output only). |
| "statusMessage": "A String", # An optional textual description of the current status of the operation (output only). |
| "status": "A String", # Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only). |
| "insertTime": "A String", # The time that this operation was requested. This is in RFC 3339 format (output only). |
| "warnings": [ # If warning messages generated during processing of this operation, this field will be populated (output only). |
| { |
| "message": "A String", # Optional human-readable details for this warning. |
| "code": "A String", # The warning type identifier for this warning. |
| "data": [ # Metadata for this warning in 'key: value' format. |
| { |
| "value": "A String", # A warning data value corresponding to the key. |
| "key": "A String", # A key for the warning data. |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # User who requested the operation, for example "user@example.com" (output only). |
| "startTime": "A String", # The time that this operation was started by the server. This is in RFC 3339 format (output only). |
| "kind": "compute#operation", # Type of the resource. |
| "name": "A String", # Name of the resource (output only). |
| "region": "A String", # URL of the region where the operation resides (output only). |
| "error": { # If errors occurred during processing of this operation, this field will be populated (output only). |
| "errors": [ # The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # An optional, human-readable error message. |
| "code": "A String", # The error type identifier for this error. |
| "location": "A String", # Indicates the field in the request which caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # The time that this operation was completed. This is in RFC 3339 format (output only). |
| "selfLink": "A String", # Server defined URL for the resource (output only). |
| "targetLink": "A String", # URL of the resource the operation is mutating (output only). |
| }</pre> |
| </div> |
| |
| </body></html> |