class Google::Cloud::Compute::V1::ForwardingRules::Rest::Client

REST client for the ForwardingRules service.

The ForwardingRules API.

Attributes

forwarding_rules_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the ForwardingRules Client class.

See {::Google::Cloud::Compute::V1::ForwardingRules::Rest::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Compute", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.aggregated_list.timeout = 600.0
    default_config.rpcs.aggregated_list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.delete.timeout = 600.0

    default_config.rpcs.get.timeout = 600.0
    default_config.rpcs.get.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.insert.timeout = 600.0

    default_config.rpcs.list.timeout = 600.0
    default_config.rpcs.list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.patch.timeout = 600.0

    default_config.rpcs.set_labels.timeout = 600.0

    default_config.rpcs.set_target.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new ForwardingRules REST client object.

@example

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

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

@yield [config] Configure the ForwardingRules client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 134
def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @forwarding_rules_stub = ::Google::Cloud::Compute::V1::ForwardingRules::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Public Instance Methods

aggregated_list(request, options = nil) { |result, response| ... } click to toggle source

Retrieves an aggregated list of forwarding rules.

@overload aggregated_list(request, options = nil)

Pass arguments to `aggregated_list` via a request object, either of type
{::Google::Cloud::Compute::V1::AggregatedListForwardingRulesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::AggregatedListForwardingRulesRequest, ::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.
@param 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

@overload aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil)

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).

@param filter [::String]
  A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`.

  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) ```
@param 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.
@param 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`)
@param 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.
@param 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.
@param project [::String]
  Project ID for this request.
@param return_partial_success [::Boolean]
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::ForwardingRulesScopedList>] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::ForwardingRulesScopedList>]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 204
def aggregated_list request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListForwardingRulesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.aggregated_list.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.aggregated_list.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.aggregated_list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @forwarding_rules_stub, :aggregated_list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
configure() { |config| ... } click to toggle source

Configure the ForwardingRules 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 {::Google::Cloud::Compute::V1::ForwardingRules::Rest::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 113
def configure
  yield @config if block_given?
  @config
end
delete(request, options = nil) { |result, response| ... } click to toggle source

Deletes the specified ForwardingRule resource.

@overload delete(request, options = nil)

Pass arguments to `delete` via a request object, either of type
{::Google::Cloud::Compute::V1::DeleteForwardingRuleRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::DeleteForwardingRuleRequest, ::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.
@param 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

@overload delete(forwarding_rule: nil, project: nil, region: nil, request_id: nil)

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).

@param forwarding_rule [::String]
  Name of the ForwardingRule resource to delete.
@param project [::String]
  Project ID for this request.
@param region [::String]
  Name of the region scoping this request.
@param 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).

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 276
def delete request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteForwardingRuleRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.delete.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.delete request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
get(request, options = nil) { |result, response| ... } click to toggle source

Returns the specified ForwardingRule resource.

@overload get(request, options = nil)

Pass arguments to `get` via a request object, either of type
{::Google::Cloud::Compute::V1::GetForwardingRuleRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::GetForwardingRuleRequest, ::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.
@param 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

@overload get(forwarding_rule: nil, project: nil, region: nil)

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).

@param forwarding_rule [::String]
  Name of the ForwardingRule resource to return.
@param project [::String]
  Project ID for this request.
@param region [::String]
  Name of the region scoping this request.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::ForwardingRule] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::ForwardingRule]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 342
def get request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetForwardingRuleRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.get.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.get request, options do |result, response|
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
insert(request, options = nil) { |result, response| ... } click to toggle source

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

@overload insert(request, options = nil)

Pass arguments to `insert` via a request object, either of type
{::Google::Cloud::Compute::V1::InsertForwardingRuleRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::InsertForwardingRuleRequest, ::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.
@param 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

@overload insert(forwarding_rule_resource: nil, project: nil, region: nil, request_id: nil)

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).

@param forwarding_rule_resource [::Google::Cloud::Compute::V1::ForwardingRule, ::Hash]
  The body resource for this request
@param project [::String]
  Project ID for this request.
@param region [::String]
  Name of the region scoping this request.
@param 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).

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 413
def insert request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertForwardingRuleRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.insert.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.insert.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.insert request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
list(request, options = nil) { |result, response| ... } click to toggle source

Retrieves a list of ForwardingRule resources available to the specified project and region.

@overload list(request, options = nil)

Pass arguments to `list` via a request object, either of type
{::Google::Cloud::Compute::V1::ListForwardingRulesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::ListForwardingRulesRequest, ::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.
@param 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

@overload list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil)

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).

@param filter [::String]
  A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`.

  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) ```
@param 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`)
@param 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.
@param 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.
@param project [::String]
  Project ID for this request.
@param region [::String]
  Name of the region scoping this request.
@param return_partial_success [::Boolean]
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::ForwardingRule>] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::ForwardingRule>]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 497
def list request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListForwardingRulesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.list.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.list request, options do |result, response|
    result = ::Gapic::Rest::PagedEnumerable.new @forwarding_rules_stub, :list, "items", request, result, options
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
patch(request, options = nil) { |result, response| ... } click to toggle source

Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.

@overload patch(request, options = nil)

Pass arguments to `patch` via a request object, either of type
{::Google::Cloud::Compute::V1::PatchForwardingRuleRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::PatchForwardingRuleRequest, ::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.
@param 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

@overload patch(forwarding_rule: nil, forwarding_rule_resource: nil, project: nil, region: nil, request_id: nil)

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).

@param forwarding_rule [::String]
  Name of the ForwardingRule resource to patch.
@param forwarding_rule_resource [::Google::Cloud::Compute::V1::ForwardingRule, ::Hash]
  The body resource for this request
@param project [::String]
  Project ID for this request.
@param region [::String]
  Name of the region scoping this request.
@param 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).

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 571
def patch request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PatchForwardingRuleRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.patch.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.patch.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.patch request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
set_labels(request, options = nil) { |result, response| ... } click to toggle source

Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.

@overload set_labels(request, options = nil)

Pass arguments to `set_labels` via a request object, either of type
{::Google::Cloud::Compute::V1::SetLabelsForwardingRuleRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::SetLabelsForwardingRuleRequest, ::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.
@param 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

@overload set_labels(project: nil, region: nil, region_set_labels_request_resource: nil, request_id: nil, resource: nil)

Pass arguments to `set_labels` 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).

@param project [::String]
  Project ID for this request.
@param region [::String]
  The region for this request.
@param region_set_labels_request_resource [::Google::Cloud::Compute::V1::RegionSetLabelsRequest, ::Hash]
  The body resource for this request
@param 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).
@param resource [::String]
  Name or id of the resource for this request.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 645
def set_labels request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetLabelsForwardingRuleRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_labels.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_labels.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.set_labels request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end
set_target(request, options = nil) { |result, response| ... } click to toggle source

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

@overload set_target(request, options = nil)

Pass arguments to `set_target` via a request object, either of type
{::Google::Cloud::Compute::V1::SetTargetForwardingRuleRequest} or an equivalent Hash.

@param request [::Google::Cloud::Compute::V1::SetTargetForwardingRuleRequest, ::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.
@param 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

@overload set_target(forwarding_rule: nil, project: nil, region: nil, request_id: nil, target_reference_resource: nil)

Pass arguments to `set_target` 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).

@param forwarding_rule [::String]
  Name of the ForwardingRule resource in which target is to be set.
@param project [::String]
  Project ID for this request.
@param region [::String]
  Name of the region scoping this request.
@param 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).
@param target_reference_resource [::Google::Cloud::Compute::V1::TargetReference, ::Hash]
  The body resource for this request

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::BaseOperation] @yieldparam response [::Faraday::Response]

@return [::Gapic::Rest::BaseOperation]

@raise [::Google::Cloud::Error] if the REST call is aborted.

# File lib/google/cloud/compute/v1/forwarding_rules/rest/client.rb, line 719
def set_target request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetTargetForwardingRuleRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_target.metadata.to_h

  # Set x-goog-api-client header
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  options.apply_defaults timeout:      @config.rpcs.set_target.timeout,
                         metadata:     call_metadata

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata

  @forwarding_rules_stub.set_target request, options do |result, response|
    result = ::Gapic::Rest::BaseOperation.new result
    yield result, response if block_given?
    return result
  end
rescue ::Faraday::Error => e
  gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e
  raise ::Google::Cloud::Error.from_error(gapic_error)
end