google-cloud-dialogflow-cx-v3 0.13.0 → 0.15.0

data/lib/google/cloud/dialogflow/cx/v3/bindings_override.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/config"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        ##
+        # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+        #
+        #     require "google/cloud/dialogflow/cx/v3/rest"
+        #     client = ::Google::Cloud::Dialogflow::CX::V3::Pages::Rest::Client.new
+        #
+        module V3
+          ##
+          # @private
+          # Initialize the mixin bindings configuration
+          #
+          def self.configure
+            @configure ||= begin
+              namespace = ["Google", "Cloud", "Dialogflow", "CX"]
+              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 = Configuration.new parent_config
+              default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+                Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                  uri_method: :get,
+                  uri_template: "/v3/{name}",
+                  matches: [
+                    ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                  ],
+                  body: nil
+                )
+              ]
+              default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+                Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                  uri_method: :get,
+                  uri_template: "/v3/{name}/locations",
+                  matches: [
+                    ["name", %r{^projects/[^/]+/?$}, false]
+                  ],
+                  body: nil
+                )
+              ]
+              default_config
+            end
+            yield @configure if block_given?
+            @configure
+          end
+
+          ##
+          # @private
+          # Configuration class for the google.cloud.dialogflow.cx.v3 package.
+          #
+          # This class contains common configuration for all services
+          # of the google.cloud.dialogflow.cx.v3 package.
+          #
+          # This configuration is for internal use of the client library classes,
+          # and it is not intended that the end-users will read or change it.
+          #
+          class Configuration
+            extend ::Gapic::Config
+
+            # @private
+            # Overrides for http bindings for the RPC of the mixins for this package.
+            # Services in this package should use these when creating clients for the mixin services.
+            # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+            config_attr :bindings_override, {}, ::Hash, nil
+
+            # @private
+            def initialize parent_config = nil
+              @parent_config = parent_config unless parent_config.nil?
+
+              yield self if block_given?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/cx/v3/changelogs/rest/client.rb

@@ -0,0 +1,472 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/errors"
+require "google/cloud/dialogflow/cx/v3/changelog_pb"
+require "google/cloud/dialogflow/cx/v3/changelogs/rest/service_stub"
+require "google/cloud/location/rest"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          module Changelogs
+            module Rest
+              ##
+              # REST client for the Changelogs service.
+              #
+              # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Changelog Changelogs}.
+              #
+              class Client
+                include Paths
+
+                # @private
+                attr_reader :changelogs_stub
+
+                ##
+                # Configure the Changelogs Client class.
+                #
+                # See {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client::Configuration}
+                # for a description of the configuration fields.
+                #
+                # @example
+                #
+                #   # Modify the configuration for all Changelogs clients
+                #   ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.configure do |config|
+                #     config.timeout = 10.0
+                #   end
+                #
+                # @yield [config] Configure the Client client.
+                # @yieldparam config [Client::Configuration]
+                #
+                # @return [Client::Configuration]
+                #
+                def self.configure
+                  @configure ||= begin
+                    namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"]
+                    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.timeout = 60.0
+                    default_config.retry_policy = {
+                      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
+                    }
+
+                    default_config
+                  end
+                  yield @configure if block_given?
+                  @configure
+                end
+
+                ##
+                # Configure the Changelogs 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::Dialogflow::CX::V3::Changelogs::Rest::Client::Configuration}
+                # for a description of the configuration fields.
+                #
+                # @yield [config] Configure the Client client.
+                # @yieldparam config [Client::Configuration]
+                #
+                # @return [Client::Configuration]
+                #
+                def configure
+                  yield @config if block_given?
+                  @config
+                end
+
+                ##
+                # Create a new Changelogs REST client object.
+                #
+                # @example
+                #
+                #   # Create a client using the default configuration
+                #   client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new
+                #
+                #   # Create a client using a custom configuration
+                #   client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new do |config|
+                #     config.timeout = 10.0
+                #   end
+                #
+                # @yield [config] Configure the Changelogs client.
+                # @yieldparam config [Client::Configuration]
+                #
+                def initialize
+                  # Create the configuration object
+                  @config = Configuration.new Client.configure
+
+                  # Yield the configuration if needed
+                  yield @config if block_given?
+
+                  # Create credentials
+                  credentials = @config.credentials
+                  # Use self-signed JWT if the endpoint is unchanged from default,
+                  # but only if the default endpoint does not have a region prefix.
+                  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
+                                           !@config.endpoint.split(".").first.include?("-")
+                  credentials ||= Credentials.default scope: @config.scope,
+                                                      enable_self_signed_jwt: enable_self_signed_jwt
+                  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                    credentials = Credentials.new credentials, scope: @config.scope
+                  end
+
+                  @quota_project_id = @config.quota_project
+                  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
+                    config.credentials = credentials
+                    config.quota_project = @quota_project_id
+                    config.endpoint = @config.endpoint
+                    config.bindings_override = @config.bindings_override
+                  end
+
+                  @changelogs_stub = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                end
+
+                ##
+                # Get the associated client for mix-in of the Locations.
+                #
+                # @return [Google::Cloud::Location::Locations::Rest::Client]
+                #
+                attr_reader :location_client
+
+                # Service calls
+
+                ##
+                # Returns the list of Changelogs.
+                #
+                # @overload list_changelogs(request, options = nil)
+                #   Pass arguments to `list_changelogs` via a request object, either of type
+                #   {::Google::Cloud::Dialogflow::CX::V3::ListChangelogsRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Cloud::Dialogflow::CX::V3::ListChangelogsRequest, ::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_changelogs(parent: nil, filter: nil, page_size: nil, page_token: nil)
+                #   Pass arguments to `list_changelogs` 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 agent containing the changelogs.
+                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #   @param filter [::String]
+                #     The filter string. Supports filter by user_email, resource, type and
+                #     create_time. Some examples:
+                #       1. By user email:
+                #            user_email = "someone@google.com"
+                #       2. By resource name:
+                #            resource = "projects/123/locations/global/agents/456/flows/789"
+                #       3. By resource display name:
+                #            display_name = "my agent"
+                #       4. By action:
+                #            action = "Create"
+                #       5. By type:
+                #            type = "flows"
+                #       6. By create time. Currently predicates on `create_time` and
+                #          `create_time_epoch_seconds` are supported:
+                #            create_time_epoch_seconds > 1551790877 AND create_time <=
+                #            2017-01-15T01:30:15.01Z
+                #       7. Combination of above filters:
+                #            resource = "projects/123/locations/global/agents/456/flows/789"
+                #              AND user_email = "someone@google.com"
+                #              AND create_time <= 2017-01-15T01:30:15.01Z
+                #   @param page_size [::Integer]
+                #     The maximum number of items to return in a single page. By default 100 and
+                #     at most 1000.
+                #   @param page_token [::String]
+                #     The next_page_token value returned from a previous list request.
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Changelog>]
+                #
+                # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                def list_changelogs request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListChangelogsRequest
+
+                  # Converts hash and nil to an options object
+                  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                  # Customize the options with defaults
+                  call_metadata = @config.rpcs.list_changelogs.metadata.to_h
+
+                  # Set x-goog-api-client and x-goog-user-project headers
+                  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                    lib_name: @config.lib_name, lib_version: @config.lib_version,
+                    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION,
+                    transports_version_send: [:rest]
+
+                  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  options.apply_defaults timeout:      @config.rpcs.list_changelogs.timeout,
+                                         metadata:     call_metadata,
+                                         retry_policy: @config.rpcs.list_changelogs.retry_policy
+
+                  options.apply_defaults timeout:      @config.timeout,
+                                         metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @changelogs_stub.list_changelogs request, options do |result, operation|
+                    result = ::Gapic::Rest::PagedEnumerable.new @changelogs_stub, :list_changelogs, "changelogs", request, result, options
+                    yield result, operation if block_given?
+                    return result
+                  end
+                rescue ::Gapic::Rest::Error => e
+                  raise ::Google::Cloud::Error.from_error(e)
+                end
+
+                ##
+                # Retrieves the specified Changelog.
+                #
+                # @overload get_changelog(request, options = nil)
+                #   Pass arguments to `get_changelog` via a request object, either of type
+                #   {::Google::Cloud::Dialogflow::CX::V3::GetChangelogRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Cloud::Dialogflow::CX::V3::GetChangelogRequest, ::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_changelog(name: nil)
+                #   Pass arguments to `get_changelog` 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 changelog to get.
+                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+                #     ID>/changelogs/<Changelog ID>`.
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Changelog]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Changelog]
+                #
+                # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                def get_changelog request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetChangelogRequest
+
+                  # Converts hash and nil to an options object
+                  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                  # Customize the options with defaults
+                  call_metadata = @config.rpcs.get_changelog.metadata.to_h
+
+                  # Set x-goog-api-client and x-goog-user-project headers
+                  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                    lib_name: @config.lib_name, lib_version: @config.lib_version,
+                    gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION,
+                    transports_version_send: [:rest]
+
+                  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  options.apply_defaults timeout:      @config.rpcs.get_changelog.timeout,
+                                         metadata:     call_metadata,
+                                         retry_policy: @config.rpcs.get_changelog.retry_policy
+
+                  options.apply_defaults timeout:      @config.timeout,
+                                         metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @changelogs_stub.get_changelog request, options do |result, operation|
+                    yield result, operation if block_given?
+                    return result
+                  end
+                rescue ::Gapic::Rest::Error => e
+                  raise ::Google::Cloud::Error.from_error(e)
+                end
+
+                ##
+                # Configuration class for the Changelogs REST API.
+                #
+                # This class represents the configuration for Changelogs REST,
+                # providing control over timeouts, retry behavior, logging, transport
+                # parameters, and other low-level controls. Certain parameters can also be
+                # applied individually to specific RPCs. See
+                # {::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client::Configuration::Rpcs}
+                # for a list of RPCs that can be configured independently.
+                #
+                # Configuration can be applied globally to all clients, or to a single client
+                # on construction.
+                #
+                # @example
+                #
+                #   # Modify the global config, setting the timeout for
+                #   # list_changelogs to 20 seconds,
+                #   # and all remaining timeouts to 10 seconds.
+                #   ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.configure do |config|
+                #     config.timeout = 10.0
+                #     config.rpcs.list_changelogs.timeout = 20.0
+                #   end
+                #
+                #   # Apply the above configuration only to a new client.
+                #   client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Rest::Client.new do |config|
+                #     config.timeout = 10.0
+                #     config.rpcs.list_changelogs.timeout = 20.0
+                #   end
+                #
+                # @!attribute [rw] endpoint
+                #   The hostname or hostname:port of the service endpoint.
+                #   Defaults to `"dialogflow.googleapis.com"`.
+                #   @return [::String]
+                # @!attribute [rw] credentials
+                #   Credentials to send with calls. You may provide any of the following types:
+                #    *  (`String`) The path to a service account key file in JSON format
+                #    *  (`Hash`) A service account key as a Hash
+                #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+                #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+                #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+                #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+                #    *  (`nil`) indicating no credentials
+                #   @return [::Object]
+                # @!attribute [rw] scope
+                #   The OAuth scopes
+                #   @return [::Array<::String>]
+                # @!attribute [rw] lib_name
+                #   The library name as recorded in instrumentation and logging
+                #   @return [::String]
+                # @!attribute [rw] lib_version
+                #   The library version as recorded in instrumentation and logging
+                #   @return [::String]
+                # @!attribute [rw] timeout
+                #   The call timeout in seconds.
+                #   @return [::Numeric]
+                # @!attribute [rw] metadata
+                #   Additional headers to be sent with the call.
+                #   @return [::Hash{::Symbol=>::String}]
+                # @!attribute [rw] retry_policy
+                #   The retry policy. The value is a hash with the following keys:
+                #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #       trigger a retry.
+                #   @return [::Hash]
+                # @!attribute [rw] quota_project
+                #   A separate project against which to charge quota.
+                #   @return [::String]
+                #
+                class Configuration
+                  extend ::Gapic::Config
+
+                  config_attr :endpoint,      "dialogflow.googleapis.com", ::String
+                  config_attr :credentials,   nil do |value|
+                    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                    allowed.any? { |klass| klass === value }
+                  end
+                  config_attr :scope,         nil, ::String, ::Array, nil
+                  config_attr :lib_name,      nil, ::String, nil
+                  config_attr :lib_version,   nil, ::String, nil
+                  config_attr :timeout,       nil, ::Numeric, nil
+                  config_attr :metadata,      nil, ::Hash, nil
+                  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                  config_attr :quota_project, nil, ::String, nil
+
+                  # @private
+                  # Overrides for http bindings for the RPCs of this service
+                  # are only used when this service is used as mixin, and only
+                  # by the host service.
+                  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+                  config_attr :bindings_override, {}, ::Hash, nil
+
+                  # @private
+                  def initialize parent_config = nil
+                    @parent_config = parent_config unless parent_config.nil?
+
+                    yield self if block_given?
+                  end
+
+                  ##
+                  # Configurations for individual RPCs
+                  # @return [Rpcs]
+                  #
+                  def rpcs
+                    @rpcs ||= begin
+                      parent_rpcs = nil
+                      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                      Rpcs.new parent_rpcs
+                    end
+                  end
+
+                  ##
+                  # Configuration RPC class for the Changelogs API.
+                  #
+                  # Includes fields providing the configuration for each RPC in this service.
+                  # Each configuration object is of type `Gapic::Config::Method` and includes
+                  # the following configuration fields:
+                  #
+                  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+                  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
+                  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                  #     include the following keys:
+                  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                  #         trigger a retry.
+                  #
+                  class Rpcs
+                    ##
+                    # RPC-specific configuration for `list_changelogs`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :list_changelogs
+                    ##
+                    # RPC-specific configuration for `get_changelog`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :get_changelog
+
+                    # @private
+                    def initialize parent_rpcs = nil
+                      list_changelogs_config = parent_rpcs.list_changelogs if parent_rpcs.respond_to? :list_changelogs
+                      @list_changelogs = ::Gapic::Config::Method.new list_changelogs_config
+                      get_changelog_config = parent_rpcs.get_changelog if parent_rpcs.respond_to? :get_changelog
+                      @get_changelog = ::Gapic::Config::Method.new get_changelog_config
+
+                      yield self if block_given?
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end