Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::TargetPools::Rest::Client (v1.3.0)

Version 1.3.0

• 2.15.0 (latest)
• 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::TargetPools::Rest::Client.

REST client for the TargetPools service.

The TargetPools API.

Inherits

• Object

Methods

.configure

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

Configure the TargetPools 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 TargetPools clients
::Google::Cloud::Compute::V1::TargetPools::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#add_health_check

def add_health_check(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_health_check(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_add_health_check_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Adds health check URLs to a target pool.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::AddHealthCheckTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def add_health_check(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_add_health_check_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to add_health_check 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) — 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).
• target_pool (::String) — Name of the target pool to add a health check to.
• target_pools_add_health_check_request_resource (::Google::Cloud::Compute::V1::TargetPoolsAddHealthCheckRequest, ::Hash) — The body resource for this request

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

Returns

• (::Gapic::GenericLRO::Operation)

Raises

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

#add_instance

def add_instance(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_instance(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_add_instance_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Adds an instance to a target pool.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::AddInstanceTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def add_instance(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_add_instance_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to add_instance 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) — 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).
• target_pool (::String) — Name of the TargetPool resource to add instances to.
• target_pools_add_instance_request_resource (::Google::Cloud::Compute::V1::TargetPoolsAddInstanceRequest, ::Hash) — The body resource for this request

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

Returns

• (::Gapic::GenericLRO::Operation)

Raises

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

#aggregated_list

def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetPoolsScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetPoolsScopedList>

Retrieves an aggregated list of target pools.

Overloads

def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetPoolsScopedList>

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

Parameters

• request (::Google::Cloud::Compute::V1::AggregatedListTargetPoolsRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetPoolsScopedList>

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. The 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)
• 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) — 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.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetPoolsScopedList>)
• response (::Faraday::Response)

Returns

• (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::TargetPoolsScopedList>)

Raises

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

#configure

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

Configure the TargetPools 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(project: nil, region: nil, request_id: nil, target_pool: nil) -> ::Gapic::GenericLRO::Operation

Deletes the specified target pool.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::DeleteTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def delete(project: nil, region: nil, request_id: nil, target_pool: 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

• 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).
• target_pool (::String) — Name of the TargetPool resource to delete.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

Returns

• (::Gapic::GenericLRO::Operation)

Raises

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

#get

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

Returns the specified target pool. Gets a list of available target pools by making a list() request.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::GetTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def get(project: nil, region: nil, target_pool: nil) -> ::Google::Cloud::Compute::V1::TargetPool

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

• project (::String) — Project ID for this request.
• region (::String) — Name of the region scoping this request.
• target_pool (::String) — Name of the TargetPool resource to return.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::TargetPool)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::TargetPool)

Raises

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

#get_health

def get_health(request, options = nil) -> ::Google::Cloud::Compute::V1::TargetPoolInstanceHealth
def get_health(instance_reference_resource: nil, project: nil, region: nil, target_pool: nil) -> ::Google::Cloud::Compute::V1::TargetPoolInstanceHealth

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::GetHealthTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def get_health(instance_reference_resource: nil, project: nil, region: nil, target_pool: nil) -> ::Google::Cloud::Compute::V1::TargetPoolInstanceHealth

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

• instance_reference_resource (::Google::Cloud::Compute::V1::InstanceReference, ::Hash) — The body resource for this request
• project (::String) — Project ID for this request.
• region (::String) — Name of the region scoping this request.
• target_pool (::String) — Name of the TargetPool resource to which the queried instance belongs.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::TargetPoolInstanceHealth)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::TargetPoolInstanceHealth)

Raises

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

#initialize

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

Create a new TargetPools REST client object.

Yields

• (config) — Configure the TargetPools 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::TargetPools::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::TargetPools::Rest::Client.new do |config|
  config.timeout = 10.0
end

#insert

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

Creates a target pool in the specified project and region using the data included in the request.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::InsertTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def insert(project: nil, region: nil, request_id: nil, target_pool_resource: 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

• 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).
• target_pool_resource (::Google::Cloud::Compute::V1::TargetPool, ::Hash) — The body resource for this request

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

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::TargetPool>
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::TargetPool>

Retrieves a list of target pools available to the specified project and region.

Overloads

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::TargetPool>

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

Parameters

• request (::Google::Cloud::Compute::V1::ListTargetPoolsRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

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::TargetPool>

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. The 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)
• 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, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::TargetPool>)
• response (::Faraday::Response)

Returns

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

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)

#remove_health_check

def remove_health_check(request, options = nil) -> ::Gapic::GenericLRO::Operation
def remove_health_check(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_remove_health_check_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Removes health check URL from a target pool.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::RemoveHealthCheckTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def remove_health_check(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_remove_health_check_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to remove_health_check 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) — Name of the region 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).
• target_pool (::String) — Name of the target pool to remove health checks from.
• target_pools_remove_health_check_request_resource (::Google::Cloud::Compute::V1::TargetPoolsRemoveHealthCheckRequest, ::Hash) — The body resource for this request

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

Returns

• (::Gapic::GenericLRO::Operation)

Raises

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

#remove_instance

def remove_instance(request, options = nil) -> ::Gapic::GenericLRO::Operation
def remove_instance(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_remove_instance_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Removes instance URL from a target pool.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::RemoveInstanceTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def remove_instance(project: nil, region: nil, request_id: nil, target_pool: nil, target_pools_remove_instance_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to remove_instance 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) — 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).
• target_pool (::String) — Name of the TargetPool resource to remove instances from.
• target_pools_remove_instance_request_resource (::Google::Cloud::Compute::V1::TargetPoolsRemoveInstanceRequest, ::Hash) — The body resource for this request

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

Returns

• (::Gapic::GenericLRO::Operation)

Raises

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

#set_backup

def set_backup(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_backup(failover_ratio: nil, project: nil, region: nil, request_id: nil, target_pool: nil, target_reference_resource: nil) -> ::Gapic::GenericLRO::Operation

Changes a backup target pool's configurations.

Overloads

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

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

Parameters

• request (::Google::Cloud::Compute::V1::SetBackupTargetPoolRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied

def set_backup(failover_ratio: nil, project: nil, region: nil, request_id: nil, target_pool: nil, target_reference_resource: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to set_backup 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

• failover_ratio (::Float) — New failoverRatio value for the target pool.
• 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).
• target_pool (::String) — Name of the TargetPool resource to set a backup pool for.
• target_reference_resource (::Google::Cloud::Compute::V1::TargetReference, ::Hash) — The body resource for this request

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Gapic::GenericLRO::Operation)
• response (::Faraday::Response)

Returns

• (::Gapic::GenericLRO::Operation)

Raises

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