# frozen_string_literal: true # Copyright 2020 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/recaptchaenterprise/v1/recaptchaenterprise_pb" module Google module Cloud module RecaptchaEnterprise module V1 module RecaptchaEnterpriseService ## # Client for the RecaptchaEnterpriseService service. # # Service to determine the likelihood an event is legitimate. # class Client # @private API_VERSION = "" # @private DEFAULT_ENDPOINT_TEMPLATE = "recaptchaenterprise.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :recaptcha_enterprise_service_stub ## # Configure the RecaptchaEnterpriseService Client class. # # See {::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all RecaptchaEnterpriseService clients # ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::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", "RecaptchaEnterprise", "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_assessment.timeout = 600.0 default_config.rpcs.annotate_assessment.timeout = 600.0 default_config.rpcs.create_key.timeout = 600.0 default_config.rpcs.list_keys.timeout = 600.0 default_config.rpcs.get_key.timeout = 600.0 default_config.rpcs.update_key.timeout = 600.0 default_config.rpcs.delete_key.timeout = 600.0 default_config end yield @configure if block_given? @configure end ## # Configure the RecaptchaEnterpriseService 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::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::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 ## # The effective universe domain # # @return [String] # def universe_domain @recaptcha_enterprise_service_stub.universe_domain end ## # Create a new RecaptchaEnterpriseService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the RecaptchaEnterpriseService 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/cloud/recaptchaenterprise/v1/recaptchaenterprise_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.nil? || (@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 @recaptcha_enterprise_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end # Service calls ## # Creates an Assessment of the likelihood an event is legitimate. # # @overload create_assessment(request, options = nil) # Pass arguments to `create_assessment` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest, ::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_assessment(parent: nil, assessment: nil) # Pass arguments to `create_assessment` 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 name of the project in which the assessment will be created, # in the format `projects/{project}`. # @param assessment [::Google::Cloud::RecaptchaEnterprise::V1::Assessment, ::Hash] # Required. The assessment details. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Assessment] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::Assessment] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest.new # # # Call the create_assessment method. # result = client.create_assessment request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Assessment. # p result # def create_assessment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest # 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_assessment.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_assessment.timeout, metadata: metadata, retry_policy: @config.rpcs.create_assessment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :create_assessment, 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 ## # Annotates a previously created Assessment to provide additional information # on whether the event turned out to be authentic or fraudulent. # # @overload annotate_assessment(request, options = nil) # Pass arguments to `annotate_assessment` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest, ::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 annotate_assessment(name: nil, annotation: nil, reasons: nil, account_id: nil, hashed_account_id: nil, transaction_event: nil) # Pass arguments to `annotate_assessment` 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. The resource name of the Assessment, in the format # `projects/{project}/assessments/{assessment}`. # @param annotation [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation] # Optional. The annotation that will be assigned to the Event. This field can # be left empty to provide reasons that apply to an event without concluding # whether the event is legitimate or fraudulent. # @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>] # Optional. Reasons for the annotation that are assigned to the event. # @param account_id [::String] # Optional. A stable account identifier to apply to the assessment. This is # an alternative to setting `account_id` in `CreateAssessment`, for example # when a stable account identifier is not yet known in the initial request. # @param hashed_account_id [::String] # Optional. A stable hashed account identifier to apply to the assessment. # This is an alternative to setting `hashed_account_id` in # `CreateAssessment`, for example when a stable account identifier is not yet # known in the initial request. # @param transaction_event [::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent, ::Hash] # Optional. If the assessment is part of a payment transaction, provide # details on payment lifecycle events that occur in the transaction. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest.new # # # Call the annotate_assessment method. # result = client.annotate_assessment request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse. # p result # def annotate_assessment request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest # 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.annotate_assessment.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.annotate_assessment.timeout, metadata: metadata, retry_policy: @config.rpcs.annotate_assessment.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :annotate_assessment, 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 new reCAPTCHA Enterprise key. # # @overload create_key(request, options = nil) # Pass arguments to `create_key` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest, ::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_key(parent: nil, key: nil) # Pass arguments to `create_key` 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 name of the project in which the key will be created, in the # format `projects/{project}`. # @param key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash] # Required. Information to create a reCAPTCHA Enterprise key. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::Key] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest.new # # # Call the create_key method. # result = client.create_key request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key. # p result # def create_key request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest # 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_key.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_key.timeout, metadata: metadata, retry_policy: @config.rpcs.create_key.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :create_key, 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 ## # Returns the list of all keys that belong to a project. # # @overload list_keys(request, options = nil) # Pass arguments to `list_keys` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest, ::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_keys(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_keys` 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 name of the project that contains the keys that will be # listed, in the format `projects/{project}`. # @param page_size [::Integer] # Optional. The maximum number of keys to return. Default is 10. Max limit is # 1000. # @param page_token [::String] # Optional. The next_page_token value returned from a previous. # ListKeysRequest, if any. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::Key>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::Key>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest.new # # # Call the list_keys method. # result = client.list_keys 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::RecaptchaEnterprise::V1::Key. # p item # end # def list_keys request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest # 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_keys.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_keys.timeout, metadata: metadata, retry_policy: @config.rpcs.list_keys.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :list_keys, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :list_keys, 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 ## # Returns the secret key related to the specified public key. # You must use the legacy secret key only in a 3rd party integration with # legacy reCAPTCHA. # # @overload retrieve_legacy_secret_key(request, options = nil) # Pass arguments to `retrieve_legacy_secret_key` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest, ::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 retrieve_legacy_secret_key(key: nil) # Pass arguments to `retrieve_legacy_secret_key` 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 key [::String] # Required. The public key name linked to the requested secret key in the # format `projects/{project}/keys/{key}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest.new # # # Call the retrieve_legacy_secret_key method. # result = client.retrieve_legacy_secret_key request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse. # p result # def retrieve_legacy_secret_key request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest # 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.retrieve_legacy_secret_key.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.key header_params["key"] = request.key 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.retrieve_legacy_secret_key.timeout, metadata: metadata, retry_policy: @config.rpcs.retrieve_legacy_secret_key.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :retrieve_legacy_secret_key, 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 ## # Returns the specified key. # # @overload get_key(request, options = nil) # Pass arguments to `get_key` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest, ::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_key(name: nil) # Pass arguments to `get_key` 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. The name of the requested key, in the format # `projects/{project}/keys/{key}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::Key] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest.new # # # Call the get_key method. # result = client.get_key request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key. # p result # def get_key request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest # 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_key.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_key.timeout, metadata: metadata, retry_policy: @config.rpcs.get_key.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :get_key, 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 key. # # @overload update_key(request, options = nil) # Pass arguments to `update_key` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest, ::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_key(key: nil, update_mask: nil) # Pass arguments to `update_key` 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 key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash] # Required. The key to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Optional. The mask to control which fields of the key get updated. If the # mask is not present, all fields will be updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::Key] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest.new # # # Call the update_key method. # result = client.update_key request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key. # p result # def update_key request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest # 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_key.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.key&.name header_params["key.name"] = request.key.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_key.timeout, metadata: metadata, retry_policy: @config.rpcs.update_key.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :update_key, 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 key. # # @overload delete_key(request, options = nil) # Pass arguments to `delete_key` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest, ::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_key(name: nil) # Pass arguments to `delete_key` 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. The name of the key to be deleted, in the format # `projects/{project}/keys/{key}`. # # @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/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest.new # # # Call the delete_key method. # result = client.delete_key request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_key request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest # 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_key.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_key.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_key.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :delete_key, 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 ## # Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. # Once a key is migrated, it can be used from either product. SiteVerify # requests are billed as CreateAssessment calls. You must be # authenticated as one of the current owners of the reCAPTCHA Key, and # your user must have the reCAPTCHA Enterprise Admin IAM role in the # destination project. # # @overload migrate_key(request, options = nil) # Pass arguments to `migrate_key` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest, ::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 migrate_key(name: nil, skip_billing_check: nil) # Pass arguments to `migrate_key` 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. The name of the key to be migrated, in the format # `projects/{project}/keys/{key}`. # @param skip_billing_check [::Boolean] # Optional. If true, skips the billing check. # A reCAPTCHA Enterprise key or migrated key behaves differently than a # reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see # https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid # any disruption of your usage, we check that a billing account is present. # If your usage of reCAPTCHA is under the free quota, you can safely skip the # billing check and proceed with the migration. See # https://cloud.google.com/recaptcha/docs/billing-information. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::Key] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest.new # # # Call the migrate_key method. # result = client.migrate_key request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key. # p result # def migrate_key request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest # 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.migrate_key.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.migrate_key.timeout, metadata: metadata, retry_policy: @config.rpcs.migrate_key.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :migrate_key, 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 ## # Adds an IP override to a key. The following restrictions hold: # * The maximum number of IP overrides per key is 100. # * For any conflict (such as IP already exists or IP part of an existing # IP range), an error will be returned. # # @overload add_ip_override(request, options = nil) # Pass arguments to `add_ip_override` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideRequest, ::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 add_ip_override(name: nil, ip_override_data: nil) # Pass arguments to `add_ip_override` 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. The name of the key to which the IP override is added, in the # format `projects/{project}/keys/{key}`. # @param ip_override_data [::Google::Cloud::RecaptchaEnterprise::V1::IpOverrideData, ::Hash] # Required. IP override added to the key. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideRequest.new # # # Call the add_ip_override method. # result = client.add_ip_override request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideResponse. # p result # def add_ip_override request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::AddIpOverrideRequest # 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.add_ip_override.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.add_ip_override.timeout, metadata: metadata, retry_policy: @config.rpcs.add_ip_override.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :add_ip_override, 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 ## # Get some aggregated metrics for a Key. This data can be used to build # dashboards. # # @overload get_metrics(request, options = nil) # Pass arguments to `get_metrics` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest, ::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_metrics(name: nil) # Pass arguments to `get_metrics` 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. The name of the requested metrics, in the format # `projects/{project}/keys/{key}/metrics`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Metrics] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::Metrics] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest.new # # # Call the get_metrics method. # result = client.get_metrics request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Metrics. # p result # def get_metrics request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest # 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_metrics.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_metrics.timeout, metadata: metadata, retry_policy: @config.rpcs.get_metrics.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :get_metrics, 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 new FirewallPolicy, specifying conditions at which reCAPTCHA # Enterprise actions can be executed. # A project may have a maximum of 1000 policies. # # @overload create_firewall_policy(request, options = nil) # Pass arguments to `create_firewall_policy` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::CreateFirewallPolicyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::CreateFirewallPolicyRequest, ::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_firewall_policy(parent: nil, firewall_policy: nil) # Pass arguments to `create_firewall_policy` 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 name of the project this policy will apply to, in the format # `projects/{project}`. # @param firewall_policy [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy, ::Hash] # Required. Information to create the policy. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::CreateFirewallPolicyRequest.new # # # Call the create_firewall_policy method. # result = client.create_firewall_policy request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy. # p result # def create_firewall_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::CreateFirewallPolicyRequest # 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_firewall_policy.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_firewall_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.create_firewall_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :create_firewall_policy, 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 ## # Returns the list of all firewall policies that belong to a project. # # @overload list_firewall_policies(request, options = nil) # Pass arguments to `list_firewall_policies` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::ListFirewallPoliciesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ListFirewallPoliciesRequest, ::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_firewall_policies(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_firewall_policies` 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 name of the project to list the policies for, in the format # `projects/{project}`. # @param page_size [::Integer] # Optional. The maximum number of policies to return. Default is 10. Max # limit is 1000. # @param page_token [::String] # Optional. The next_page_token value returned from a previous. # ListFirewallPoliciesRequest, if any. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::ListFirewallPoliciesRequest.new # # # Call the list_firewall_policies method. # result = client.list_firewall_policies 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::RecaptchaEnterprise::V1::FirewallPolicy. # p item # end # def list_firewall_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListFirewallPoliciesRequest # 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_firewall_policies.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_firewall_policies.timeout, metadata: metadata, retry_policy: @config.rpcs.list_firewall_policies.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :list_firewall_policies, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :list_firewall_policies, 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 ## # Returns the specified firewall policy. # # @overload get_firewall_policy(request, options = nil) # Pass arguments to `get_firewall_policy` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::GetFirewallPolicyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::GetFirewallPolicyRequest, ::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_firewall_policy(name: nil) # Pass arguments to `get_firewall_policy` 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. The name of the requested policy, in the format # `projects/{project}/firewallpolicies/{firewallpolicy}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::GetFirewallPolicyRequest.new # # # Call the get_firewall_policy method. # result = client.get_firewall_policy request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy. # p result # def get_firewall_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::GetFirewallPolicyRequest # 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_firewall_policy.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_firewall_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_firewall_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :get_firewall_policy, 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 policy. # # @overload update_firewall_policy(request, options = nil) # Pass arguments to `update_firewall_policy` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::UpdateFirewallPolicyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::UpdateFirewallPolicyRequest, ::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_firewall_policy(firewall_policy: nil, update_mask: nil) # Pass arguments to `update_firewall_policy` 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 firewall_policy [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy, ::Hash] # Required. The policy to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Optional. The mask to control which fields of the policy get updated. If # the mask is not present, all fields will be updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::UpdateFirewallPolicyRequest.new # # # Call the update_firewall_policy method. # result = client.update_firewall_policy request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::FirewallPolicy. # p result # def update_firewall_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::UpdateFirewallPolicyRequest # 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_firewall_policy.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.firewall_policy&.name header_params["firewall_policy.name"] = request.firewall_policy.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_firewall_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.update_firewall_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :update_firewall_policy, 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 policy. # # @overload delete_firewall_policy(request, options = nil) # Pass arguments to `delete_firewall_policy` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::DeleteFirewallPolicyRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::DeleteFirewallPolicyRequest, ::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_firewall_policy(name: nil) # Pass arguments to `delete_firewall_policy` 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. The name of the policy to be deleted, in the format # `projects/{project}/firewallpolicies/{firewallpolicy}`. # # @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/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::DeleteFirewallPolicyRequest.new # # # Call the delete_firewall_policy method. # result = client.delete_firewall_policy request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_firewall_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::DeleteFirewallPolicyRequest # 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_firewall_policy.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_firewall_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_firewall_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :delete_firewall_policy, 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 ## # Reorders all firewall policies. # # @overload reorder_firewall_policies(request, options = nil) # Pass arguments to `reorder_firewall_policies` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesRequest, ::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 reorder_firewall_policies(parent: nil, names: nil) # Pass arguments to `reorder_firewall_policies` 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 name of the project to list the policies for, in the format # `projects/{project}`. # @param names [::Array<::String>] # Required. A list containing all policy names, in the new order. Each name # is in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesRequest.new # # # Call the reorder_firewall_policies method. # result = client.reorder_firewall_policies request # # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesResponse. # p result # def reorder_firewall_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ReorderFirewallPoliciesRequest # 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.reorder_firewall_policies.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.reorder_firewall_policies.timeout, metadata: metadata, retry_policy: @config.rpcs.reorder_firewall_policies.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :reorder_firewall_policies, 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 ## # List groups of related accounts. # # @overload list_related_account_groups(request, options = nil) # Pass arguments to `list_related_account_groups` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest, ::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_related_account_groups(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_related_account_groups` 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 name of the project to list related account groups from, in # the format `projects/{project}`. # @param page_size [::Integer] # Optional. The maximum number of groups to return. The service might return # fewer than this value. If unspecified, at most 50 groups are returned. The # maximum value is 1000; values above 1000 are coerced to 1000. # @param page_token [::String] # Optional. A page token, received from a previous `ListRelatedAccountGroups` # call. Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListRelatedAccountGroups` must match the call that provided the page # token. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest.new # # # Call the list_related_account_groups method. # result = client.list_related_account_groups 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::RecaptchaEnterprise::V1::RelatedAccountGroup. # p item # end # def list_related_account_groups request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest # 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_related_account_groups.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_related_account_groups.timeout, metadata: metadata, retry_policy: @config.rpcs.list_related_account_groups.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :list_related_account_groups, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :list_related_account_groups, 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 ## # Get memberships in a group of related accounts. # # @overload list_related_account_group_memberships(request, options = nil) # Pass arguments to `list_related_account_group_memberships` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest, ::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_related_account_group_memberships(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_related_account_group_memberships` 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 resource name for the related account group in the format # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`. # @param page_size [::Integer] # Optional. The maximum number of accounts to return. The service might # return fewer than this value. If unspecified, at most 50 accounts are # returned. The maximum value is 1000; values above 1000 are coerced to 1000. # @param page_token [::String] # Optional. A page token, received from a previous # `ListRelatedAccountGroupMemberships` call. # # When paginating, all other parameters provided to # `ListRelatedAccountGroupMemberships` must match the call that provided the # page token. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest.new # # # Call the list_related_account_group_memberships method. # result = client.list_related_account_group_memberships 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::RecaptchaEnterprise::V1::RelatedAccountGroupMembership. # p item # end # def list_related_account_group_memberships request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest # 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_related_account_group_memberships.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_related_account_group_memberships.timeout, metadata: metadata, retry_policy: @config.rpcs.list_related_account_group_memberships.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :list_related_account_group_memberships, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :list_related_account_group_memberships, 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 ## # Search group memberships related to a given account. # # @overload search_related_account_group_memberships(request, options = nil) # Pass arguments to `search_related_account_group_memberships` via a request object, either of type # {::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest, ::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 search_related_account_group_memberships(project: nil, account_id: nil, hashed_account_id: nil, page_size: nil, page_token: nil) # Pass arguments to `search_related_account_group_memberships` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param project [::String] # Required. The name of the project to search related account group # memberships from. Specify the project name in the following format: # `projects/{project}`. # @param account_id [::String] # Optional. The unique stable account identifier used to search connections. # The identifier should correspond to an `account_id` provided in a previous # `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id # or account_id must be set, but not both. # @param hashed_account_id [::String] # Optional. Deprecated: use `account_id` instead. # The unique stable hashed account identifier used to search connections. The # identifier should correspond to a `hashed_account_id` provided in a # previous `CreateAssessment` or `AnnotateAssessment` call. Either # hashed_account_id or account_id must be set, but not both. # @param page_size [::Integer] # Optional. The maximum number of groups to return. The service might return # fewer than this value. If unspecified, at most 50 groups are returned. The # maximum value is 1000; values above 1000 are coerced to 1000. # @param page_token [::String] # Optional. A page token, received from a previous # `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the # subsequent page. # # When paginating, all other parameters provided to # `SearchRelatedAccountGroupMemberships` must match the call that provided # the page token. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/recaptcha_enterprise/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest.new # # # Call the search_related_account_group_memberships method. # result = client.search_related_account_group_memberships 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::RecaptchaEnterprise::V1::RelatedAccountGroupMembership. # p item # end # def search_related_account_group_memberships request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest # 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.search_related_account_group_memberships.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::RecaptchaEnterprise::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.project header_params["project"] = request.project 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.search_related_account_group_memberships.timeout, metadata: metadata, retry_policy: @config.rpcs.search_related_account_group_memberships.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recaptcha_enterprise_service_stub.call_rpc :search_related_account_group_memberships, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :search_related_account_group_memberships, 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 ## # Configuration class for the RecaptchaEnterpriseService API. # # This class represents the configuration for RecaptchaEnterpriseService, # 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::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::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 # # create_assessment to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_assessment.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_assessment.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!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`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "recaptchaenterprise.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :universe_domain, 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 for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the RecaptchaEnterpriseService 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`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_assessment` # @return [::Gapic::Config::Method] # attr_reader :create_assessment ## # RPC-specific configuration for `annotate_assessment` # @return [::Gapic::Config::Method] # attr_reader :annotate_assessment ## # RPC-specific configuration for `create_key` # @return [::Gapic::Config::Method] # attr_reader :create_key ## # RPC-specific configuration for `list_keys` # @return [::Gapic::Config::Method] # attr_reader :list_keys ## # RPC-specific configuration for `retrieve_legacy_secret_key` # @return [::Gapic::Config::Method] # attr_reader :retrieve_legacy_secret_key ## # RPC-specific configuration for `get_key` # @return [::Gapic::Config::Method] # attr_reader :get_key ## # RPC-specific configuration for `update_key` # @return [::Gapic::Config::Method] # attr_reader :update_key ## # RPC-specific configuration for `delete_key` # @return [::Gapic::Config::Method] # attr_reader :delete_key ## # RPC-specific configuration for `migrate_key` # @return [::Gapic::Config::Method] # attr_reader :migrate_key ## # RPC-specific configuration for `add_ip_override` # @return [::Gapic::Config::Method] # attr_reader :add_ip_override ## # RPC-specific configuration for `get_metrics` # @return [::Gapic::Config::Method] # attr_reader :get_metrics ## # RPC-specific configuration for `create_firewall_policy` # @return [::Gapic::Config::Method] # attr_reader :create_firewall_policy ## # RPC-specific configuration for `list_firewall_policies` # @return [::Gapic::Config::Method] # attr_reader :list_firewall_policies ## # RPC-specific configuration for `get_firewall_policy` # @return [::Gapic::Config::Method] # attr_reader :get_firewall_policy ## # RPC-specific configuration for `update_firewall_policy` # @return [::Gapic::Config::Method] # attr_reader :update_firewall_policy ## # RPC-specific configuration for `delete_firewall_policy` # @return [::Gapic::Config::Method] # attr_reader :delete_firewall_policy ## # RPC-specific configuration for `reorder_firewall_policies` # @return [::Gapic::Config::Method] # attr_reader :reorder_firewall_policies ## # RPC-specific configuration for `list_related_account_groups` # @return [::Gapic::Config::Method] # attr_reader :list_related_account_groups ## # RPC-specific configuration for `list_related_account_group_memberships` # @return [::Gapic::Config::Method] # attr_reader :list_related_account_group_memberships ## # RPC-specific configuration for `search_related_account_group_memberships` # @return [::Gapic::Config::Method] # attr_reader :search_related_account_group_memberships # @private def initialize parent_rpcs = nil create_assessment_config = parent_rpcs.create_assessment if parent_rpcs.respond_to? :create_assessment @create_assessment = ::Gapic::Config::Method.new create_assessment_config annotate_assessment_config = parent_rpcs.annotate_assessment if parent_rpcs.respond_to? :annotate_assessment @annotate_assessment = ::Gapic::Config::Method.new annotate_assessment_config create_key_config = parent_rpcs.create_key if parent_rpcs.respond_to? :create_key @create_key = ::Gapic::Config::Method.new create_key_config list_keys_config = parent_rpcs.list_keys if parent_rpcs.respond_to? :list_keys @list_keys = ::Gapic::Config::Method.new list_keys_config retrieve_legacy_secret_key_config = parent_rpcs.retrieve_legacy_secret_key if parent_rpcs.respond_to? :retrieve_legacy_secret_key @retrieve_legacy_secret_key = ::Gapic::Config::Method.new retrieve_legacy_secret_key_config get_key_config = parent_rpcs.get_key if parent_rpcs.respond_to? :get_key @get_key = ::Gapic::Config::Method.new get_key_config update_key_config = parent_rpcs.update_key if parent_rpcs.respond_to? :update_key @update_key = ::Gapic::Config::Method.new update_key_config delete_key_config = parent_rpcs.delete_key if parent_rpcs.respond_to? :delete_key @delete_key = ::Gapic::Config::Method.new delete_key_config migrate_key_config = parent_rpcs.migrate_key if parent_rpcs.respond_to? :migrate_key @migrate_key = ::Gapic::Config::Method.new migrate_key_config add_ip_override_config = parent_rpcs.add_ip_override if parent_rpcs.respond_to? :add_ip_override @add_ip_override = ::Gapic::Config::Method.new add_ip_override_config get_metrics_config = parent_rpcs.get_metrics if parent_rpcs.respond_to? :get_metrics @get_metrics = ::Gapic::Config::Method.new get_metrics_config create_firewall_policy_config = parent_rpcs.create_firewall_policy if parent_rpcs.respond_to? :create_firewall_policy @create_firewall_policy = ::Gapic::Config::Method.new create_firewall_policy_config list_firewall_policies_config = parent_rpcs.list_firewall_policies if parent_rpcs.respond_to? :list_firewall_policies @list_firewall_policies = ::Gapic::Config::Method.new list_firewall_policies_config get_firewall_policy_config = parent_rpcs.get_firewall_policy if parent_rpcs.respond_to? :get_firewall_policy @get_firewall_policy = ::Gapic::Config::Method.new get_firewall_policy_config update_firewall_policy_config = parent_rpcs.update_firewall_policy if parent_rpcs.respond_to? :update_firewall_policy @update_firewall_policy = ::Gapic::Config::Method.new update_firewall_policy_config delete_firewall_policy_config = parent_rpcs.delete_firewall_policy if parent_rpcs.respond_to? :delete_firewall_policy @delete_firewall_policy = ::Gapic::Config::Method.new delete_firewall_policy_config reorder_firewall_policies_config = parent_rpcs.reorder_firewall_policies if parent_rpcs.respond_to? :reorder_firewall_policies @reorder_firewall_policies = ::Gapic::Config::Method.new reorder_firewall_policies_config list_related_account_groups_config = parent_rpcs.list_related_account_groups if parent_rpcs.respond_to? :list_related_account_groups @list_related_account_groups = ::Gapic::Config::Method.new list_related_account_groups_config list_related_account_group_memberships_config = parent_rpcs.list_related_account_group_memberships if parent_rpcs.respond_to? :list_related_account_group_memberships @list_related_account_group_memberships = ::Gapic::Config::Method.new list_related_account_group_memberships_config search_related_account_group_memberships_config = parent_rpcs.search_related_account_group_memberships if parent_rpcs.respond_to? :search_related_account_group_memberships @search_related_account_group_memberships = ::Gapic::Config::Method.new search_related_account_group_memberships_config yield self if block_given? end end end end end end end end end