class Google::Cloud::ApiGateway::V1::ApiGatewayService::Client
Client
for the ApiGatewayService
service.
The API Gateway
Service
is the interface for managing API Gateways.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::ApiGateway::V1::ApiGatewayService::Operations]
Public Class Methods
Configure the ApiGatewayService
Client
class.
See {::Google::Cloud::ApiGateway::V1::ApiGatewayService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all ApiGatewayService clients ::Google::Cloud::ApiGateway::V1::ApiGatewayService::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/api_gateway/v1/api_gateway_service/client.rb, line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ApiGateway", "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.create_gateway.timeout = 60.0 default_config.rpcs.create_gateway.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.update_gateway.timeout = 60.0 default_config.rpcs.update_gateway.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.delete_gateway.timeout = 60.0 default_config.rpcs.delete_gateway.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.create_api.timeout = 60.0 default_config.rpcs.create_api.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.update_api.timeout = 60.0 default_config.rpcs.update_api.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.delete_api.timeout = 60.0 default_config.rpcs.delete_api.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.create_api_config.timeout = 60.0 default_config.rpcs.create_api_config.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.update_api_config.timeout = 60.0 default_config.rpcs.update_api_config.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config.rpcs.delete_api_config.timeout = 60.0 default_config.rpcs.delete_api_config.retry_policy = { initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [2, 14] } default_config end yield @configure if block_given? @configure end
Create a new ApiGatewayService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the ApiGatewayService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 154 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/cloud/apigateway/v1/apigateway_service_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 @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @api_gateway_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ApiGateway::V1::ApiGatewayService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the ApiGatewayService
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::ApiGateway::V1::ApiGatewayService::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/api_gateway/v1/api_gateway_service/client.rb, line 133 def configure yield @config if block_given? @config end
Creates a new Api
in a given project and location.
@overload create_api
(request, options = nil)
Pass arguments to `create_api` via a request object, either of type {::Google::Cloud::ApiGateway::V1::CreateApiRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::CreateApiRequest, ::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_api
(parent: nil, api_id: nil, api: nil)
Pass arguments to `create_api` 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] Required. Parent resource of the API, of the form: `projects/*/locations/global` @param api_id [::String] Required. Identifier to assign to the API. Must be unique within scope of the parent resource. @param api [::Google::Cloud::ApiGateway::V1::Api, ::Hash] Required. API resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 753 def create_api request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::CreateApiRequest # 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_api.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_api.timeout, metadata: metadata, retry_policy: @config.rpcs.create_api.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :create_api, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Creates a new ApiConfig
in a given project and location.
@overload create_api_config
(request, options = nil)
Pass arguments to `create_api_config` via a request object, either of type {::Google::Cloud::ApiGateway::V1::CreateApiConfigRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::CreateApiConfigRequest, ::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_api_config
(parent: nil, api_config_id: nil, api_config: nil)
Pass arguments to `create_api_config` 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] Required. Parent resource of the API Config, of the form: `projects/*/locations/global/apis/*` @param api_config_id [::String] Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. @param api_config [::Google::Cloud::ApiGateway::V1::ApiConfig, ::Hash] Required. API resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 1123 def create_api_config request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::CreateApiConfigRequest # 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_api_config.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_api_config.timeout, metadata: metadata, retry_policy: @config.rpcs.create_api_config.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :create_api_config, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Creates a new Gateway
in a given project and location.
@overload create_gateway
(request, options = nil)
Pass arguments to `create_gateway` via a request object, either of type {::Google::Cloud::ApiGateway::V1::CreateGatewayRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::CreateGatewayRequest, ::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_gateway
(parent: nil, gateway_id: nil, gateway: nil)
Pass arguments to `create_gateway` 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] Required. Parent resource of the Gateway, of the form: `projects/*/locations/*` @param gateway_id [::String] Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource. @param gateway [::Google::Cloud::ApiGateway::V1::Gateway, ::Hash] Required. Gateway resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 386 def create_gateway request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::CreateGatewayRequest # 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_gateway.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_gateway.timeout, metadata: metadata, retry_policy: @config.rpcs.create_gateway.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :create_gateway, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a single Api
.
@overload delete_api
(request, options = nil)
Pass arguments to `delete_api` via a request object, either of type {::Google::Cloud::ApiGateway::V1::DeleteApiRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::DeleteApiRequest, ::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_api
(name: nil)
Pass arguments to `delete_api` 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] Required. Resource name of the form: `projects/*/locations/global/apis/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 898 def delete_api request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::DeleteApiRequest # 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_api.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_api.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_api.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :delete_api, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a single ApiConfig
.
@overload delete_api_config
(request, options = nil)
Pass arguments to `delete_api_config` via a request object, either of type {::Google::Cloud::ApiGateway::V1::DeleteApiConfigRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::DeleteApiConfigRequest, ::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_api_config
(name: nil)
Pass arguments to `delete_api_config` 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] Required. Resource name of the form: `projects/*/locations/global/apis/*/configs/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 1268 def delete_api_config request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::DeleteApiConfigRequest # 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_api_config.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_api_config.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_api_config.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :delete_api_config, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a single Gateway
.
@overload delete_gateway
(request, options = nil)
Pass arguments to `delete_gateway` via a request object, either of type {::Google::Cloud::ApiGateway::V1::DeleteGatewayRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::DeleteGatewayRequest, ::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_gateway
(name: nil)
Pass arguments to `delete_gateway` 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] Required. Resource name of the form: `projects/*/locations/*/gateways/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 531 def delete_gateway request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::DeleteGatewayRequest # 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_gateway.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_gateway.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_gateway.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :delete_gateway, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets details of a single Api
.
@overload get_api
(request, options = nil)
Pass arguments to `get_api` via a request object, either of type {::Google::Cloud::ApiGateway::V1::GetApiRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::GetApiRequest, ::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_api
(name: nil)
Pass arguments to `get_api` 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] Required. Resource name of the form: `projects/*/locations/global/apis/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ApiGateway::V1::Api] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ApiGateway::V1::Api]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 679 def get_api request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::GetApiRequest # 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_api.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_api.timeout, metadata: metadata, retry_policy: @config.rpcs.get_api.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :get_api, 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 details of a single ApiConfig
.
@overload get_api_config
(request, options = nil)
Pass arguments to `get_api_config` via a request object, either of type {::Google::Cloud::ApiGateway::V1::GetApiConfigRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::GetApiConfigRequest, ::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_api_config
(name: nil, view: nil)
Pass arguments to `get_api_config` 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] Required. Resource name of the form: `projects/*/locations/global/apis/*/configs/*` @param view [::Google::Cloud::ApiGateway::V1::GetApiConfigRequest::ConfigView] Specifies which fields of the API Config are returned in the response. Defaults to `BASIC` view.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ApiGateway::V1::ApiConfig] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ApiGateway::V1::ApiConfig]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 1049 def get_api_config request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::GetApiConfigRequest # 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_api_config.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_api_config.timeout, metadata: metadata, retry_policy: @config.rpcs.get_api_config.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :get_api_config, 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 details of a single Gateway
.
@overload get_gateway
(request, options = nil)
Pass arguments to `get_gateway` via a request object, either of type {::Google::Cloud::ApiGateway::V1::GetGatewayRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::GetGatewayRequest, ::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_gateway
(name: nil)
Pass arguments to `get_gateway` 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] Required. Resource name of the form: `projects/*/locations/*/gateways/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ApiGateway::V1::Gateway] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ApiGateway::V1::Gateway]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 312 def get_gateway request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::GetGatewayRequest # 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_gateway.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } 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_gateway.timeout, metadata: metadata, retry_policy: @config.rpcs.get_gateway.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :get_gateway, 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
Lists ApiConfigs in a given project and location.
@overload list_api_configs
(request, options = nil)
Pass arguments to `list_api_configs` via a request object, either of type {::Google::Cloud::ApiGateway::V1::ListApiConfigsRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::ListApiConfigsRequest, ::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_api_configs
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_api_configs` 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] Required. Parent resource of the API Config, of the form: `projects/*/locations/global/apis/*` @param page_size [::Integer] Page size. @param page_token [::String] Page token. @param filter [::String] Filter. @param order_by [::String] Order by parameters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ApiGateway::V1::ApiConfig>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ApiGateway::V1::ApiConfig>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 976 def list_api_configs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::ListApiConfigsRequest # 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_api_configs.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_api_configs.timeout, metadata: metadata, retry_policy: @config.rpcs.list_api_configs.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :list_api_configs, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @api_gateway_service_stub, :list_api_configs, 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
Lists Apis in a given project and location.
@overload list_apis
(request, options = nil)
Pass arguments to `list_apis` via a request object, either of type {::Google::Cloud::ApiGateway::V1::ListApisRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::ListApisRequest, ::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_apis
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_apis` 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] Required. Parent resource of the API, of the form: `projects/*/locations/global` @param page_size [::Integer] Page size. @param page_token [::String] Page token. @param filter [::String] Filter. @param order_by [::String] Order by parameters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ApiGateway::V1::Api>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ApiGateway::V1::Api>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 609 def list_apis request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::ListApisRequest # 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_apis.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_apis.timeout, metadata: metadata, retry_policy: @config.rpcs.list_apis.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :list_apis, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @api_gateway_service_stub, :list_apis, 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
Lists Gateways in a given project and location.
@overload list_gateways
(request, options = nil)
Pass arguments to `list_gateways` via a request object, either of type {::Google::Cloud::ApiGateway::V1::ListGatewaysRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::ListGatewaysRequest, ::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_gateways
(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
Pass arguments to `list_gateways` 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] Required. Parent resource of the Gateway, of the form: `projects/*/locations/*` @param page_size [::Integer] Page size. @param page_token [::String] Page token. @param filter [::String] Filter. @param order_by [::String] Order by parameters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ApiGateway::V1::Gateway>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ApiGateway::V1::Gateway>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 242 def list_gateways request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::ListGatewaysRequest # 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_gateways.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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_gateways.timeout, metadata: metadata, retry_policy: @config.rpcs.list_gateways.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :list_gateways, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @api_gateway_service_stub, :list_gateways, 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
Updates the parameters of a single Api
.
@overload update_api
(request, options = nil)
Pass arguments to `update_api` via a request object, either of type {::Google::Cloud::ApiGateway::V1::UpdateApiRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::UpdateApiRequest, ::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_api
(update_mask: nil, api: nil)
Pass arguments to `update_api` 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 update_mask [::Google::Protobuf::FieldMask, ::Hash] Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. @param api [::Google::Cloud::ApiGateway::V1::Api, ::Hash] Required. API resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 828 def update_api request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::UpdateApiRequest # 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_api.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "api.name" => request.api.name } 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_api.timeout, metadata: metadata, retry_policy: @config.rpcs.update_api.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :update_api, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates the parameters of a single ApiConfig
.
@overload update_api_config
(request, options = nil)
Pass arguments to `update_api_config` via a request object, either of type {::Google::Cloud::ApiGateway::V1::UpdateApiConfigRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::UpdateApiConfigRequest, ::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_api_config
(update_mask: nil, api_config: nil)
Pass arguments to `update_api_config` 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 update_mask [::Google::Protobuf::FieldMask, ::Hash] Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. @param api_config [::Google::Cloud::ApiGateway::V1::ApiConfig, ::Hash] Required. API Config resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 1198 def update_api_config request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::UpdateApiConfigRequest # 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_api_config.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "api_config.name" => request.api_config.name } 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_api_config.timeout, metadata: metadata, retry_policy: @config.rpcs.update_api_config.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :update_api_config, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates the parameters of a single Gateway
.
@overload update_gateway
(request, options = nil)
Pass arguments to `update_gateway` via a request object, either of type {::Google::Cloud::ApiGateway::V1::UpdateGatewayRequest} or an equivalent Hash. @param request [::Google::Cloud::ApiGateway::V1::UpdateGatewayRequest, ::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_gateway
(update_mask: nil, gateway: nil)
Pass arguments to `update_gateway` 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 update_mask [::Google::Protobuf::FieldMask, ::Hash] Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. @param gateway [::Google::Cloud::ApiGateway::V1::Gateway, ::Hash] Required. Gateway resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/api_gateway/v1/api_gateway_service/client.rb, line 461 def update_gateway request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ApiGateway::V1::UpdateGatewayRequest # 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_gateway.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::ApiGateway::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "gateway.name" => request.gateway.name } 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_gateway.timeout, metadata: metadata, retry_policy: @config.rpcs.update_gateway.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @api_gateway_service_stub.call_rpc :update_gateway, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end