# frozen_string_literal: true # Copyright 2023 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/cloud/advisorynotifications/v1/service_pb" require "google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/service_stub" module Google module Cloud module AdvisoryNotifications module V1 module AdvisoryNotificationsService module Rest ## # REST client for the AdvisoryNotificationsService service. # # Service to manage Security and Privacy Notifications. # class Client include Paths # @private attr_reader :advisory_notifications_service_stub ## # Configure the AdvisoryNotificationsService Client class. # # See {::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all AdvisoryNotificationsService clients # ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::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", "AdvisoryNotifications", "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.list_notifications.timeout = 60.0 default_config.rpcs.list_notifications.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_notification.timeout = 60.0 default_config.rpcs.get_notification.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the AdvisoryNotificationsService 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::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::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 AdvisoryNotificationsService REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the AdvisoryNotificationsService client. # @yieldparam config [Client::Configuration] # 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 # 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 == Configuration::DEFAULT_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 @advisory_notifications_service_stub = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end # Service calls ## # Lists notifications under a given parent. # # @overload list_notifications(request, options = nil) # Pass arguments to `list_notifications` via a request object, either of type # {::Google::Cloud::AdvisoryNotifications::V1::ListNotificationsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AdvisoryNotifications::V1::ListNotificationsRequest, ::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_notifications(parent: nil, page_size: nil, page_token: nil, view: nil, language_code: nil) # Pass arguments to `list_notifications` 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. The parent, which owns this collection of notifications. # Must be of the form "organizations/\\{organization}/locations/\\{location}". # @param page_size [::Integer] # The maximum number of notifications to return. The service may return # fewer than this value. If unspecified or equal to 0, at most 50 # notifications will be returned. The maximum value is 50; values above 50 # will be coerced to 50. # @param page_token [::String] # A page token returned from a previous request. # When paginating, all other parameters provided in the request # must match the call that returned the page token. # @param view [::Google::Cloud::AdvisoryNotifications::V1::NotificationView] # Specifies which parts of the notification resource should be returned # in the response. # @param language_code [::String] # ISO code for requested localization language. If unset, will be # interpereted as "en". If the requested language is valid, but not supported # for this notification, English will be returned with an "Not applicable" # LocalizationState. If the ISO code is invalid (i.e. not a real language), # this RPC will throw an error. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_notifications request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AdvisoryNotifications::V1::ListNotificationsRequest # 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_notifications.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::AdvisoryNotifications::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.list_notifications.timeout, metadata: call_metadata, retry_policy: @config.rpcs.list_notifications.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @advisory_notifications_service_stub.list_notifications request, options do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @advisory_notifications_service_stub, :list_notifications, "notifications", request, result, options yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets a notification. # # @overload get_notification(request, options = nil) # Pass arguments to `get_notification` via a request object, either of type # {::Google::Cloud::AdvisoryNotifications::V1::GetNotificationRequest} or an equivalent Hash. # # @param request [::Google::Cloud::AdvisoryNotifications::V1::GetNotificationRequest, ::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_notification(name: nil, language_code: nil) # Pass arguments to `get_notification` 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. A name of the notification to retrieve. # Format: # organizations/\\{organization}/locations/\\{location}/notifications/\\{notification}. # @param language_code [::String] # ISO code for requested localization language. If unset, will be # interpereted as "en". If the requested language is valid, but not supported # for this notification, English will be returned with an "Not applicable" # LocalizationState. If the ISO code is invalid (i.e. not a real language), # this RPC will throw an error. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::AdvisoryNotifications::V1::Notification] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::AdvisoryNotifications::V1::Notification] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get_notification request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AdvisoryNotifications::V1::GetNotificationRequest # 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_notification.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::AdvisoryNotifications::V1::VERSION, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.get_notification.timeout, metadata: call_metadata, retry_policy: @config.rpcs.get_notification.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @advisory_notifications_service_stub.get_notification request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the AdvisoryNotificationsService REST API. # # This class represents the configuration for AdvisoryNotificationsService REST, # 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::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::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_notifications to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_notifications.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_notifications.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"advisorynotifications.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)) # * (`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] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional 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`) - 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 DEFAULT_ENDPOINT = "advisorynotifications.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] 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 :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 AdvisoryNotificationsService 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 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`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_notifications` # @return [::Gapic::Config::Method] # attr_reader :list_notifications ## # RPC-specific configuration for `get_notification` # @return [::Gapic::Config::Method] # attr_reader :get_notification # @private def initialize parent_rpcs = nil list_notifications_config = parent_rpcs.list_notifications if parent_rpcs.respond_to? :list_notifications @list_notifications = ::Gapic::Config::Method.new list_notifications_config get_notification_config = parent_rpcs.get_notification if parent_rpcs.respond_to? :get_notification @get_notification = ::Gapic::Config::Method.new get_notification_config yield self if block_given? end end end end end end end end end end