# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::BackendServices::Rest::Client (v3.7.0)
3.7.0 (latest) 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.22.0 2.21.1 2.20.0 2.19.1 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.2 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.10.0 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.5.0 Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::BackendServices::Rest::Client.
REST client for the BackendServices service.
The BackendServices API.
## Inherits
- Object
## Methods
### .configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the BackendServices Client class.
See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration "Google::Cloud::Compute::V1::BackendServices::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**
- (config) --- Configure the Client client.
**Yield Parameter**
- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration))
**Returns**
- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration))
**Example**
```ruby
# Modify the configuration for all BackendServices clients
::Google::Cloud::Compute::V1::BackendServices::Rest::Client.configure do |config|
config.timeout = 10.0
end
```
### #add_signed_url_key
def add_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_signed_url_key(backend_service: nil, project: nil, request_id: nil, signed_url_key_resource: nil) -> ::Gapic::GenericLRO::Operation
Adds a key for validating requests with signed URLs for this backend
service.
**Overloads**
def add_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `add_signed_url_key` via a request object, either of type [AddSignedUrlKeyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AddSignedUrlKeyBackendServiceRequest "Google::Cloud::Compute::V1::AddSignedUrlKeyBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::AddSignedUrlKeyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AddSignedUrlKeyBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def add_signed_url_key(backend_service: nil, project: nil, request_id: nil, signed_url_key_resource: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `add_signed_url_key` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
- **signed_url_key_resource** ([::Google::Cloud::Compute::V1::SignedUrlKey](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SignedUrlKey), ::Hash) --- The body resource for this request
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::AddSignedUrlKeyBackendServiceRequest.new
# Call the add_signed_url_key method.
result = client.add_signed_url_key request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #aggregated_list
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, service_project_number: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>
Retrieves the list of all BackendService resources, regional and global,
available to the specified project.
To prevent failure, it is recommended that you set the
`returnPartialSuccess` parameter to `true`.
**Overloads**
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>
Pass arguments to `aggregated_list` via a request object, either of type [AggregatedListBackendServicesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AggregatedListBackendServicesRequest "Google::Cloud::Compute::V1::AggregatedListBackendServicesRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::AggregatedListBackendServicesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AggregatedListBackendServicesRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, service_project_number: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList>
Pass arguments to `aggregated_list` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **filter** (::String) --- A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.
The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
`
labels.owner:*
`
You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
`
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
`
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
`
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
`
If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
`fieldname eq unquoted literal`
`fieldname eq 'single quoted literal'`
`fieldname eq "double quoted literal"`
`(fieldname1 eq literal) (fieldname2 ne "literal")`
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use `name ne .*instance`.
You cannot combine constraints on multiple fields using regular
expressions.
- **include_all_scopes** (::Boolean) --- Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
- **max_results** (::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`)
- **order_by** (::String) --- Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation
timestamp using `orderBy="creationTimestamp desc"`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.
Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
- **page_token** (::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.
- **project** (::String) --- Name of the project scoping this request.
- **return_partial_success** (::Boolean) --- Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
- **service_project_number** (::Integer) --- The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::Rest::PagedEnumerable\<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList\>)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::Rest::PagedEnumerable\<::String, ::Google::Cloud::Compute::V1::BackendServicesScopedList\>)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::AggregatedListBackendServicesRequest.new
# Call the aggregated_list method.
result = client.aggregated_list request
# The returned object is of type Google::Cloud::Compute::V1::BackendServiceAggregatedList.
p result
```
### #configure
def configure() { |config| ... } -> Client::Configuration
Configure the BackendServices Client instance.
The configuration is set to the derived mode, meaning that values can be changed,
but structural changes (adding new fields, etc.) are not allowed. Structural changes
should be made on [Client.configure](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client#Google__Cloud__Compute__V1__BackendServices__Rest__Client_configure_class_ "Google::Cloud::Compute::V1::BackendServices::Rest::Client.configure (method)").
See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration "Google::Cloud::Compute::V1::BackendServices::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**
- (config) --- Configure the Client client.
**Yield Parameter**
- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration))
**Returns**
- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration))
### #delete
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(backend_service: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Deletes the specified BackendService resource.
**Overloads**
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `delete` via a request object, either of type [DeleteBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DeleteBackendServiceRequest "Google::Cloud::Compute::V1::DeleteBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::DeleteBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DeleteBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete(backend_service: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `delete` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to delete.
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::DeleteBackendServiceRequest.new
# Call the delete method.
result = client.delete request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #delete_signed_url_key
def delete_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete_signed_url_key(backend_service: nil, key_name: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Deletes a key for validating requests with signed URLs for this backend
service.
**Overloads**
def delete_signed_url_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `delete_signed_url_key` via a request object, either of type [DeleteSignedUrlKeyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DeleteSignedUrlKeyBackendServiceRequest "Google::Cloud::Compute::V1::DeleteSignedUrlKeyBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::DeleteSignedUrlKeyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DeleteSignedUrlKeyBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_signed_url_key(backend_service: nil, key_name: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `delete_signed_url_key` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
- **key_name** (::String) --- The name of the Signed URL Key to delete.
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::DeleteSignedUrlKeyBackendServiceRequest.new
# Call the delete_signed_url_key method.
result = client.delete_signed_url_key request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendService
def get(backend_service: nil, project: nil) -> ::Google::Cloud::Compute::V1::BackendService
Returns the specified BackendService resource.
**Overloads**
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendService
Pass arguments to `get` via a request object, either of type [GetBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetBackendServiceRequest "Google::Cloud::Compute::V1::GetBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::GetBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get(backend_service: nil, project: nil) -> ::Google::Cloud::Compute::V1::BackendService
Pass arguments to `get` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to return.
- **project** (::String) --- Project ID for this request.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** ([::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- ([::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService))
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetBackendServiceRequest.new
# Call the get method.
result = client.get request
# The returned object is of type Google::Cloud::Compute::V1::BackendService.
p result
```
### #get_effective_security_policies
def get_effective_security_policies(request, options = nil) -> ::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse
def get_effective_security_policies(backend_service: nil, project: nil) -> ::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse
Returns effective security policies applied to this backend service.
**Overloads**
def get_effective_security_policies(request, options = nil) -> ::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse
Pass arguments to `get_effective_security_policies` via a request object, either of type [GetEffectiveSecurityPoliciesBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetEffectiveSecurityPoliciesBackendServiceRequest "Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetEffectiveSecurityPoliciesBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_effective_security_policies(backend_service: nil, project: nil) -> ::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse
Pass arguments to `get_effective_security_policies` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the Backend Service for this request.
- **project** (::String) --- Project ID for this request.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** ([::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetEffectiveSecurityPoliciesBackendServiceResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- ([::Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetEffectiveSecurityPoliciesBackendServiceResponse))
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceRequest.new
# Call the get_effective_security_policies method.
result = client.get_effective_security_policies request
# The returned object is of type Google::Cloud::Compute::V1::GetEffectiveSecurityPoliciesBackendServiceResponse.
p result
```
### #get_health
def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
def get_health(backend_service: nil, project: nil, resource_group_reference_resource: nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
Gets the most recent health check results for this
BackendService.
Example request body:
{
"group": "/zones/us-east1-b/instanceGroups/lb-backend-example"
}
**Overloads**
def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
Pass arguments to `get_health` via a request object, either of type [GetHealthBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetHealthBackendServiceRequest "Google::Cloud::Compute::V1::GetHealthBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::GetHealthBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetHealthBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_health(backend_service: nil, project: nil, resource_group_reference_resource: nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
Pass arguments to `get_health` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to which the queried instance belongs.
- **project** (::String)
- **resource_group_reference_resource** ([::Google::Cloud::Compute::V1::ResourceGroupReference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ResourceGroupReference), ::Hash) --- The body resource for this request
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** ([::Google::Cloud::Compute::V1::BackendServiceGroupHealth](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServiceGroupHealth))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- ([::Google::Cloud::Compute::V1::BackendServiceGroupHealth](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServiceGroupHealth))
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetHealthBackendServiceRequest.new
# Call the get_health method.
result = client.get_health request
# The returned object is of type Google::Cloud::Compute::V1::BackendServiceGroupHealth.
p result
```
### #get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Gets the access control policy for a resource. May be empty if no such
policy or resource exists.
**Overloads**
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
Pass arguments to `get_iam_policy` via a request object, either of type [GetIamPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetIamPolicyBackendServiceRequest "Google::Cloud::Compute::V1::GetIamPolicyBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::GetIamPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetIamPolicyBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Pass arguments to `get_iam_policy` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **options_requested_policy_version** (::Integer) --- Requested IAM Policy version.
- **project** (::String) --- Project ID for this request.
- **resource** (::String) --- Name or id of the resource for this request.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** ([::Google::Cloud::Compute::V1::Policy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Policy))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- ([::Google::Cloud::Compute::V1::Policy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Policy))
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetIamPolicyBackendServiceRequest.new
# Call the get_iam_policy method.
result = client.get_iam_policy request
# The returned object is of type Google::Cloud::Compute::V1::Policy.
p result
```
### #global_operations
def global_operations() -> ::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client
Get the associated client for long-running operations via GlobalOperations.
**Returns**
- ([::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GlobalOperations-Rest-Client))
### #initialize
def initialize() { |config| ... } -> Client
Create a new BackendServices REST client object.
**Yields**
- (config) --- Configure the BackendServices client.
**Yield Parameter**
- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client-Configuration))
**Returns**
- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendServices-Rest-Client)) --- a new instance of Client
**Example**
```ruby
# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::BackendServices::Rest::Client.new do |config|
config.timeout = 10.0
end
```
### #insert
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Creates a BackendService resource in the specified project using
the data included in the request. For more information, see
Backend services overview.
**Overloads**
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `insert` via a request object, either of type [InsertBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-InsertBackendServiceRequest "Google::Cloud::Compute::V1::InsertBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::InsertBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-InsertBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def insert(backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `insert` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service_resource** ([::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService), ::Hash) --- The body resource for this request
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::InsertBackendServiceRequest.new
# Call the insert method.
result = client.insert request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #list
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
Retrieves the list of BackendService resources available to the specified
project.
**Overloads**
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
Pass arguments to `list` via a request object, either of type [ListBackendServicesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ListBackendServicesRequest "Google::Cloud::Compute::V1::ListBackendServicesRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::ListBackendServicesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ListBackendServicesRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
Pass arguments to `list` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **filter** (::String) --- A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.
The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
`
labels.owner:*
`
You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
`
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
`
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
`
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
`
If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
`fieldname eq unquoted literal`
`fieldname eq 'single quoted literal'`
`fieldname eq "double quoted literal"`
`(fieldname1 eq literal) (fieldname2 ne "literal")`
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use `name ne .*instance`.
You cannot combine constraints on multiple fields using regular
expressions.
- **max_results** (::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`)
- **order_by** (::String) --- Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation
timestamp using `orderBy="creationTimestamp desc"`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.
Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
- **page_token** (::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.
- **project** (::String) --- Project ID for this request.
- **return_partial_success** (::Boolean) --- Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService)\>)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService)\>)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::ListBackendServicesRequest.new
# Call the list method.
result = client.list request
# The returned object is of type Google::Cloud::Compute::V1::BackendServiceList.
p result
```
### #list_usable
def list_usable(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
def list_usable(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
Retrieves a list of all usable backend services in the specified project.
**Overloads**
def list_usable(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
Pass arguments to `list_usable` via a request object, either of type [ListUsableBackendServicesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ListUsableBackendServicesRequest "Google::Cloud::Compute::V1::ListUsableBackendServicesRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::ListUsableBackendServicesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ListUsableBackendServicesRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_usable(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>
Pass arguments to `list_usable` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **filter** (::String) --- A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.
The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
`
labels.owner:*
`
You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
`
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
`
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
`
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
`
If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
`fieldname eq unquoted literal`
`fieldname eq 'single quoted literal'`
`fieldname eq "double quoted literal"`
`(fieldname1 eq literal) (fieldname2 ne "literal")`
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use `name ne .*instance`.
You cannot combine constraints on multiple fields using regular
expressions.
- **max_results** (::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`)
- **order_by** (::String) --- Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation
timestamp using `orderBy="creationTimestamp desc"`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.
Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
- **page_token** (::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.
- **project** (::String) --- Project ID for this request.
- **return_partial_success** (::Boolean) --- Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService)\>)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService)\>)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::ListUsableBackendServicesRequest.new
# Call the list_usable method.
result = client.list_usable request
# The returned object is of type Google::Cloud::Compute::V1::BackendServiceListUsable.
p result
```
### #logger
def logger() -> Logger
The logger used for request/response debug logging.
**Returns**
- (Logger)
### #patch
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch(backend_service: nil, backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Patches the specified BackendService resource with the data included in the
request. For more information, see
Backend services overview. This method
supports PATCH semantics and uses the JSON merge
patch format and processing rules.
**Overloads**
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `patch` via a request object, either of type [PatchBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-PatchBackendServiceRequest "Google::Cloud::Compute::V1::PatchBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::PatchBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-PatchBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def patch(backend_service: nil, backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `patch` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to patch.
- **backend_service_resource** ([::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService), ::Hash) --- The body resource for this request
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::PatchBackendServiceRequest.new
# Call the patch method.
result = client.patch request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #set_edge_security_policy
def set_edge_security_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_edge_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::GenericLRO::Operation
Sets the edge security policy for the specified backend service.
**Overloads**
def set_edge_security_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `set_edge_security_policy` via a request object, either of type [SetEdgeSecurityPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SetEdgeSecurityPolicyBackendServiceRequest "Google::Cloud::Compute::V1::SetEdgeSecurityPolicyBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::SetEdgeSecurityPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SetEdgeSecurityPolicyBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def set_edge_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `set_edge_security_policy` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
- **security_policy_reference_resource** ([::Google::Cloud::Compute::V1::SecurityPolicyReference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SecurityPolicyReference), ::Hash) --- The body resource for this request
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::SetEdgeSecurityPolicyBackendServiceRequest.new
# Call the set_edge_security_policy method.
result = client.set_edge_security_policy request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def set_iam_policy(global_set_policy_request_resource: nil, project: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Sets the access control policy on the specified resource.
Replaces any existing policy.
**Overloads**
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
Pass arguments to `set_iam_policy` via a request object, either of type [SetIamPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SetIamPolicyBackendServiceRequest "Google::Cloud::Compute::V1::SetIamPolicyBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::SetIamPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SetIamPolicyBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def set_iam_policy(global_set_policy_request_resource: nil, project: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Pass arguments to `set_iam_policy` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **global_set_policy_request_resource** ([::Google::Cloud::Compute::V1::GlobalSetPolicyRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GlobalSetPolicyRequest), ::Hash) --- The body resource for this request
- **project** (::String) --- Project ID for this request.
- **resource** (::String) --- Name or id of the resource for this request.
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** ([::Google::Cloud::Compute::V1::Policy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Policy))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- ([::Google::Cloud::Compute::V1::Policy](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-Policy))
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::SetIamPolicyBackendServiceRequest.new
# Call the set_iam_policy method.
result = client.set_iam_policy request
# The returned object is of type Google::Cloud::Compute::V1::Policy.
p result
```
### #set_security_policy
def set_security_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::GenericLRO::Operation
Sets the Google Cloud Armor security policy for the specified backend
service. For more information, seeGoogle
Cloud Armor Overview
**Overloads**
def set_security_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `set_security_policy` via a request object, either of type [SetSecurityPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SetSecurityPolicyBackendServiceRequest "Google::Cloud::Compute::V1::SetSecurityPolicyBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::SetSecurityPolicyBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SetSecurityPolicyBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def set_security_policy(backend_service: nil, project: nil, request_id: nil, security_policy_reference_resource: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `set_security_policy` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
- **security_policy_reference_resource** ([::Google::Cloud::Compute::V1::SecurityPolicyReference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-SecurityPolicyReference), ::Hash) --- The body resource for this request
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::SetSecurityPolicyBackendServiceRequest.new
# Call the set_security_policy method.
result = client.set_security_policy request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```
### #test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
**Overloads**
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Pass arguments to `test_iam_permissions` via a request object, either of type [TestIamPermissionsBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-TestIamPermissionsBackendServiceRequest "Google::Cloud::Compute::V1::TestIamPermissionsBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::TestIamPermissionsBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-TestIamPermissionsBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Pass arguments to `test_iam_permissions` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **project** (::String) --- Project ID for this request.
- **resource** (::String) --- Name or id of the resource for this request.
- **test_permissions_request_resource** ([::Google::Cloud::Compute::V1::TestPermissionsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-TestPermissionsRequest), ::Hash) --- The body resource for this request
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** ([::Google::Cloud::Compute::V1::TestPermissionsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-TestPermissionsResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- ([::Google::Cloud::Compute::V1::TestPermissionsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-TestPermissionsResponse))
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::TestIamPermissionsBackendServiceRequest.new
# Call the test_iam_permissions method.
result = client.test_iam_permissions request
# The returned object is of type Google::Cloud::Compute::V1::TestPermissionsResponse.
p result
```
### #universe_domain
def universe_domain() -> String
The effective universe domain
**Returns**
- (String)
### #update
def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update(backend_service: nil, backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Updates the specified BackendService resource with the data included in the
request. For more information, seeBackend
services overview.
**Overloads**
def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `update` via a request object, either of type [UpdateBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-UpdateBackendServiceRequest "Google::Cloud::Compute::V1::UpdateBackendServiceRequest (class)") or an equivalent Hash. **Parameters**
- **request** ([::Google::Cloud::Compute::V1::UpdateBackendServiceRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-UpdateBackendServiceRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update(backend_service: nil, backend_service_resource: nil, project: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation
Pass arguments to `update` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**
- **backend_service** (::String) --- Name of the BackendService resource to update.
- **backend_service_resource** ([::Google::Cloud::Compute::V1::BackendService](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-BackendService), ::Hash) --- The body resource for this request
- **project** (::String) --- Project ID for this request.
- **request_id** (::String) --- An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
**Yields**
- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**
- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**
- (::Gapic::GenericLRO::Operation)
**Raises**
- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**
Basic example
```ruby
require "google/cloud/compute/v1"
# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::BackendServices::Rest::Client.new
# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::UpdateBackendServiceRequest.new
# Call the update method.
result = client.update request
# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```