Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::RegionBackendServices::Rest::Client (v2.3.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::RegionBackendServices::Rest::Client.

REST client for the RegionBackendServices service.

The RegionBackendServices API.

Inherits

Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the RegionBackendServices Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all RegionBackendServices clients
::Google::Cloud::Compute::V1::RegionBackendServices::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the RegionBackendServices 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.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#delete

def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(backend_service: nil, project: nil, region: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

Deletes the specified regional BackendService resource.

Overloads

def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to delete via a request object, either of type DeleteRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::DeleteRegionBackendServiceRequest, ::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, region: 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.
region (::String) — Name of the region scoping 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.

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendService
def get(backend_service: nil, project: nil, region: nil) -> ::Google::Cloud::Compute::V1::BackendService

Returns the specified regional BackendService resource.

Overloads

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendService

Pass arguments to get via a request object, either of type GetRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::GetRegionBackendServiceRequest, ::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, region: 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.
region (::String) — Name of the region scoping this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::BackendService)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::BackendService)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#get_health

def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth
def get_health(backend_service: nil, project: nil, region: nil, resource_group_reference_resource: nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth

Gets the most recent health check results for this regional BackendService.

Overloads

def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::BackendServiceGroupHealth

Pass arguments to get_health via a request object, either of type GetHealthRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::GetHealthRegionBackendServiceRequest, ::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, region: 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 for which to get health.
project (::String)
region (::String) — Name of the region scoping this request.
resource_group_reference_resource (::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)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::BackendServiceGroupHealth)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#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, region: 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 GetIamPolicyRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::GetIamPolicyRegionBackendServiceRequest, ::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, region: 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.
region (::String) — The name of the region 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)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Policy)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#initialize

def initialize() { |config| ... } -> Client

Create a new RegionBackendServices REST client object.

Yields

(config) — Configure the RegionBackendServices client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::RegionBackendServices::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::RegionBackendServices::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, region: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

Creates a regional 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 InsertRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::InsertRegionBackendServiceRequest, ::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, region: 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, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
region (::String) — Name of the region scoping 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.

#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, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>

Retrieves the list of regional BackendService resources available to the specified project in the given region.

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 ListRegionBackendServicesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::ListRegionBackendServicesRequest, ::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, region: 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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) 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 Google RE2 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.
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.
region (::String) — Name of the region 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.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::BackendService>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#patch

def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch(backend_service: nil, backend_service_resource: nil, project: nil, region: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services 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 PatchRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::PatchRegionBackendServiceRequest, ::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, region: 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, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
region (::String) — Name of the region scoping 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.

#region_operations

def region_operations() -> ::Google::Cloud::Compute::V1::RegionOperations::Rest::Client

Get the associated client for long-running operations via RegionOperations.

Returns

(::Google::Cloud::Compute::V1::RegionOperations::Rest::Client)

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def set_iam_policy(project: nil, region: nil, region_set_policy_request_resource: 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 SetIamPolicyRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::SetIamPolicyRegionBackendServiceRequest, ::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(project: nil, region: nil, region_set_policy_request_resource: 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

project (::String) — Project ID for this request.
region (::String) — The name of the region for this request.
region_set_policy_request_resource (::Google::Cloud::Compute::V1::RegionSetPolicyRequest, ::Hash) — The body resource 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)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Policy)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

#update

def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update(backend_service: nil, backend_service_resource: nil, project: nil, region: nil, request_id: nil) -> ::Gapic::GenericLRO::Operation

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Overloads

def update(request, options = nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to update via a request object, either of type UpdateRegionBackendServiceRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::UpdateRegionBackendServiceRequest, ::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, region: 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, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
region (::String) — Name of the region scoping 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.