# frozen_string_literal: true
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "google/cloud/errors"
require "google/appengine/v1/appengine_pb"
module Google
module Cloud
module AppEngine
module V1
module Firewall
##
# Client for the Firewall service.
#
# Firewall resources are used to define a collection of access control rules
# for an Application. Each rule is defined with a position which specifies
# the rule's order in the sequence of rules, an IP range to be matched against
# requests, and an action to take upon matching requests.
#
# Every request is evaluated against the Firewall rules in priority order.
# Processesing stops at the first rule which matches the request's IP address.
# A final rule always specifies an action that applies to all remaining
# IP addresses. The default final rule for a newly-created application will be
# set to "allow" if not otherwise specified by the user.
#
class Client
# @private
attr_reader :firewall_stub
##
# Configure the Firewall Client class.
#
# See {::Google::Cloud::AppEngine::V1::Firewall::Client::Configuration}
# for a description of the configuration fields.
#
# @example
#
# # Modify the configuration for all Firewall clients
# ::Google::Cloud::AppEngine::V1::Firewall::Client.configure do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def self.configure
@configure ||= begin
namespace = ["Google", "Cloud", "AppEngine", "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
end
yield @configure if block_given?
@configure
end
##
# Configure the Firewall 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::AppEngine::V1::Firewall::Client::Configuration}
# for a description of the configuration fields.
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def configure
yield @config if block_given?
@config
end
##
# Create a new Firewall client object.
#
# @example
#
# # Create a client using the default configuration
# client = ::Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a client using a custom configuration
# client = ::Google::Cloud::AppEngine::V1::Firewall::Client.new do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the Firewall client.
# @yieldparam config [Client::Configuration]
#
def initialize
# These require statements are intentionally placed here to initialize
# the gRPC module only when it's required.
# See https://github.com/googleapis/toolkit/issues/446
require "gapic/grpc"
require "google/appengine/v1/appengine_services_pb"
# Create the configuration object
@config = Configuration.new Client.configure
# Yield the configuration if needed
yield @config if block_given?
# Create credentials
credentials = @config.credentials
# Use self-signed JWT if the endpoint is unchanged from default,
# but only if the default endpoint does not have a region prefix.
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
!@config.endpoint.split(".").first.include?("-")
credentials ||= Credentials.default scope: @config.scope,
enable_self_signed_jwt: enable_self_signed_jwt
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
credentials = Credentials.new credentials, scope: @config.scope
end
@quota_project_id = @config.quota_project
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
@firewall_stub = ::Gapic::ServiceStub.new(
::Google::Cloud::AppEngine::V1::Firewall::Stub,
credentials: credentials,
endpoint: @config.endpoint,
channel_args: @config.channel_args,
interceptors: @config.interceptors
)
end
# Service calls
##
# Lists the firewall rules of an application.
#
# @overload list_ingress_rules(request, options = nil)
# Pass arguments to `list_ingress_rules` via a request object, either of type
# {::Google::Cloud::AppEngine::V1::ListIngressRulesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AppEngine::V1::ListIngressRulesRequest, ::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.
#
# @overload list_ingress_rules(parent: nil, page_size: nil, page_token: nil, matching_address: nil)
# Pass arguments to `list_ingress_rules` 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 parent [::String]
# Name of the Firewall collection to retrieve.
# Example: `apps/myapp/firewall/ingressRules`.
# @param page_size [::Integer]
# Maximum results to return per page.
# @param page_token [::String]
# Continuation token for fetching the next page of results.
# @param matching_address [::String]
# A valid IP Address. If set, only rules matching this address will be
# returned. The first returned rule will be the rule that fires on requests
# from this IP.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::AppEngine::V1::FirewallRule>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/app_engine/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AppEngine::V1::ListIngressRulesRequest.new
#
# # Call the list_ingress_rules method.
# result = client.list_ingress_rules request
#
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
# # over elements, and API calls will be issued to fetch pages as needed.
# result.each do |item|
# # Each element is of type ::Google::Cloud::AppEngine::V1::FirewallRule.
# p item
# end
#
def list_ingress_rules request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::ListIngressRulesRequest
# 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
metadata = @config.rpcs.list_ingress_rules.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AppEngine::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_ingress_rules.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_ingress_rules.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@firewall_stub.call_rpc :list_ingress_rules, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @firewall_stub, :list_ingress_rules, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Replaces the entire firewall ruleset in one bulk operation. This overrides
# and replaces the rules of an existing firewall with the new rules.
#
# If the final rule does not match traffic with the '*' wildcard IP range,
# then an "allow all" rule is explicitly added to the end of the list.
#
# @overload batch_update_ingress_rules(request, options = nil)
# Pass arguments to `batch_update_ingress_rules` via a request object, either of type
# {::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest, ::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.
#
# @overload batch_update_ingress_rules(name: nil, ingress_rules: nil)
# Pass arguments to `batch_update_ingress_rules` 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 name [::String]
# Name of the Firewall collection to set.
# Example: `apps/myapp/firewall/ingressRules`.
# @param ingress_rules [::Array<::Google::Cloud::AppEngine::V1::FirewallRule, ::Hash>]
# A list of FirewallRules to replace the existing set.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/app_engine/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest.new
#
# # Call the batch_update_ingress_rules method.
# result = client.batch_update_ingress_rules request
#
# # The returned object is of type Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesResponse.
# p result
#
def batch_update_ingress_rules request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::BatchUpdateIngressRulesRequest
# 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
metadata = @config.rpcs.batch_update_ingress_rules.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AppEngine::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.batch_update_ingress_rules.timeout,
metadata: metadata,
retry_policy: @config.rpcs.batch_update_ingress_rules.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@firewall_stub.call_rpc :batch_update_ingress_rules, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Creates a firewall rule for the application.
#
# @overload create_ingress_rule(request, options = nil)
# Pass arguments to `create_ingress_rule` via a request object, either of type
# {::Google::Cloud::AppEngine::V1::CreateIngressRuleRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AppEngine::V1::CreateIngressRuleRequest, ::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.
#
# @overload create_ingress_rule(parent: nil, rule: nil)
# Pass arguments to `create_ingress_rule` 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 parent [::String]
# Name of the parent Firewall collection in which to create a new rule.
# Example: `apps/myapp/firewall/ingressRules`.
# @param rule [::Google::Cloud::AppEngine::V1::FirewallRule, ::Hash]
# A FirewallRule containing the new resource.
#
# The user may optionally provide a position at which the new rule will be
# placed. The positions define a sequential list starting at 1. If a rule
# already exists at the given position, rules greater than the provided
# position will be moved forward by one.
#
# If no position is provided, the server will place the rule as the second to
# last rule in the sequence before the required default allow-all or deny-all
# rule.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AppEngine::V1::FirewallRule]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AppEngine::V1::FirewallRule]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/app_engine/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AppEngine::V1::CreateIngressRuleRequest.new
#
# # Call the create_ingress_rule method.
# result = client.create_ingress_rule request
#
# # The returned object is of type Google::Cloud::AppEngine::V1::FirewallRule.
# p result
#
def create_ingress_rule request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::CreateIngressRuleRequest
# 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
metadata = @config.rpcs.create_ingress_rule.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AppEngine::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.create_ingress_rule.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_ingress_rule.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@firewall_stub.call_rpc :create_ingress_rule, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets the specified firewall rule.
#
# @overload get_ingress_rule(request, options = nil)
# Pass arguments to `get_ingress_rule` via a request object, either of type
# {::Google::Cloud::AppEngine::V1::GetIngressRuleRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AppEngine::V1::GetIngressRuleRequest, ::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.
#
# @overload get_ingress_rule(name: nil)
# Pass arguments to `get_ingress_rule` 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 name [::String]
# Name of the Firewall resource to retrieve.
# Example: `apps/myapp/firewall/ingressRules/100`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AppEngine::V1::FirewallRule]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AppEngine::V1::FirewallRule]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/app_engine/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AppEngine::V1::GetIngressRuleRequest.new
#
# # Call the get_ingress_rule method.
# result = client.get_ingress_rule request
#
# # The returned object is of type Google::Cloud::AppEngine::V1::FirewallRule.
# p result
#
def get_ingress_rule request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::GetIngressRuleRequest
# 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
metadata = @config.rpcs.get_ingress_rule.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AppEngine::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_ingress_rule.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_ingress_rule.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@firewall_stub.call_rpc :get_ingress_rule, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Updates the specified firewall rule.
#
# @overload update_ingress_rule(request, options = nil)
# Pass arguments to `update_ingress_rule` via a request object, either of type
# {::Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest, ::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.
#
# @overload update_ingress_rule(name: nil, rule: nil, update_mask: nil)
# Pass arguments to `update_ingress_rule` 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 name [::String]
# Name of the Firewall resource to update.
# Example: `apps/myapp/firewall/ingressRules/100`.
# @param rule [::Google::Cloud::AppEngine::V1::FirewallRule, ::Hash]
# A FirewallRule containing the updated resource
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# Standard field mask for the set of fields to be updated.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::AppEngine::V1::FirewallRule]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::AppEngine::V1::FirewallRule]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/app_engine/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest.new
#
# # Call the update_ingress_rule method.
# result = client.update_ingress_rule request
#
# # The returned object is of type Google::Cloud::AppEngine::V1::FirewallRule.
# p result
#
def update_ingress_rule request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::UpdateIngressRuleRequest
# 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
metadata = @config.rpcs.update_ingress_rule.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AppEngine::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.update_ingress_rule.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_ingress_rule.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@firewall_stub.call_rpc :update_ingress_rule, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Deletes the specified firewall rule.
#
# @overload delete_ingress_rule(request, options = nil)
# Pass arguments to `delete_ingress_rule` via a request object, either of type
# {::Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest, ::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.
#
# @overload delete_ingress_rule(name: nil)
# Pass arguments to `delete_ingress_rule` 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 name [::String]
# Name of the Firewall resource to delete.
# Example: `apps/myapp/firewall/ingressRules/100`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Protobuf::Empty]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Protobuf::Empty]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/app_engine/v1"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::AppEngine::V1::Firewall::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest.new
#
# # Call the delete_ingress_rule method.
# result = client.delete_ingress_rule request
#
# # The returned object is of type Google::Protobuf::Empty.
# p result
#
def delete_ingress_rule request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AppEngine::V1::DeleteIngressRuleRequest
# 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
metadata = @config.rpcs.delete_ingress_rule.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::AppEngine::V1::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.delete_ingress_rule.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_ingress_rule.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@firewall_stub.call_rpc :delete_ingress_rule, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Configuration class for the Firewall API.
#
# This class represents the configuration for Firewall,
# providing control over timeouts, retry behavior, logging, transport
# parameters, and other low-level controls. Certain parameters can also be
# applied individually to specific RPCs. See
# {::Google::Cloud::AppEngine::V1::Firewall::Client::Configuration::Rpcs}
# for a list of RPCs that can be configured independently.
#
# Configuration can be applied globally to all clients, or to a single client
# on construction.
#
# @example
#
# # Modify the global config, setting the timeout for
# # list_ingress_rules to 20 seconds,
# # and all remaining timeouts to 10 seconds.
# ::Google::Cloud::AppEngine::V1::Firewall::Client.configure do |config|
# config.timeout = 10.0
# config.rpcs.list_ingress_rules.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::AppEngine::V1::Firewall::Client.new do |config|
# config.timeout = 10.0
# config.rpcs.list_ingress_rules.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"appengine.googleapis.com"`.
# @return [::String]
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
# * (`nil`) indicating no credentials
# @return [::Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [::Array<::String>]
# @!attribute [rw] lib_name
# The library name as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] lib_version
# The library version as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] channel_args
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
# `GRPC::Core::Channel` object is provided as the credential.
# @return [::Hash]
# @!attribute [rw] interceptors
# An array of interceptors that are run before calls are executed.
# @return [::Array<::GRPC::ClientInterceptor>]
# @!attribute [rw] timeout
# The call timeout in seconds.
# @return [::Numeric]
# @!attribute [rw] metadata
# Additional gRPC headers to be sent with the call.
# @return [::Hash{::Symbol=>::String}]
# @!attribute [rw] retry_policy
# The retry policy. The value is a hash with the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
# @return [::Hash]
# @!attribute [rw] quota_project
# A separate project against which to charge quota.
# @return [::String]
#
class Configuration
extend ::Gapic::Config
config_attr :endpoint, "appengine.googleapis.com", ::String
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
allowed.any? { |klass| klass === value }
end
config_attr :scope, nil, ::String, ::Array, nil
config_attr :lib_name, nil, ::String, nil
config_attr :lib_version, nil, ::String, nil
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
config_attr :interceptors, nil, ::Array, nil
config_attr :timeout, nil, ::Numeric, nil
config_attr :metadata, nil, ::Hash, nil
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
config_attr :quota_project, nil, ::String, nil
# @private
def initialize parent_config = nil
@parent_config = parent_config unless parent_config.nil?
yield self if block_given?
end
##
# Configurations for individual RPCs
# @return [Rpcs]
#
def rpcs
@rpcs ||= begin
parent_rpcs = nil
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
Rpcs.new parent_rpcs
end
end
##
# Configuration RPC class for the Firewall API.
#
# Includes fields providing the configuration for each RPC in this service.
# Each configuration object is of type `Gapic::Config::Method` and includes
# the following configuration fields:
#
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
# include the following keys:
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
#
class Rpcs
##
# RPC-specific configuration for `list_ingress_rules`
# @return [::Gapic::Config::Method]
#
attr_reader :list_ingress_rules
##
# RPC-specific configuration for `batch_update_ingress_rules`
# @return [::Gapic::Config::Method]
#
attr_reader :batch_update_ingress_rules
##
# RPC-specific configuration for `create_ingress_rule`
# @return [::Gapic::Config::Method]
#
attr_reader :create_ingress_rule
##
# RPC-specific configuration for `get_ingress_rule`
# @return [::Gapic::Config::Method]
#
attr_reader :get_ingress_rule
##
# RPC-specific configuration for `update_ingress_rule`
# @return [::Gapic::Config::Method]
#
attr_reader :update_ingress_rule
##
# RPC-specific configuration for `delete_ingress_rule`
# @return [::Gapic::Config::Method]
#
attr_reader :delete_ingress_rule
# @private
def initialize parent_rpcs = nil
list_ingress_rules_config = parent_rpcs.list_ingress_rules if parent_rpcs.respond_to? :list_ingress_rules
@list_ingress_rules = ::Gapic::Config::Method.new list_ingress_rules_config
batch_update_ingress_rules_config = parent_rpcs.batch_update_ingress_rules if parent_rpcs.respond_to? :batch_update_ingress_rules
@batch_update_ingress_rules = ::Gapic::Config::Method.new batch_update_ingress_rules_config
create_ingress_rule_config = parent_rpcs.create_ingress_rule if parent_rpcs.respond_to? :create_ingress_rule
@create_ingress_rule = ::Gapic::Config::Method.new create_ingress_rule_config
get_ingress_rule_config = parent_rpcs.get_ingress_rule if parent_rpcs.respond_to? :get_ingress_rule
@get_ingress_rule = ::Gapic::Config::Method.new get_ingress_rule_config
update_ingress_rule_config = parent_rpcs.update_ingress_rule if parent_rpcs.respond_to? :update_ingress_rule
@update_ingress_rule = ::Gapic::Config::Method.new update_ingress_rule_config
delete_ingress_rule_config = parent_rpcs.delete_ingress_rule if parent_rpcs.respond_to? :delete_ingress_rule
@delete_ingress_rule = ::Gapic::Config::Method.new delete_ingress_rule_config
yield self if block_given?
end
end
end
end
end
end
end
end
end