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

data/lib/google/cloud/dialogflow/cx/v3/experiments/rest/service_stub.rb

@@ -0,0 +1,467 @@
+# 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/dialogflow/cx/v3/experiment_pb"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          module Experiments
+            module Rest
+              ##
+              # REST service stub for the Experiments service.
+              # Service stub contains baseline method implementations
+              # including transcoding, making the REST call, and deserialing the response.
+              #
+              class ServiceStub
+                def initialize endpoint:, credentials:
+                  # These require statements are intentionally placed here to initialize
+                  # the REST modules only when it's required.
+                  require "gapic/rest"
+
+                  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                               numeric_enums: true,
+                                                               raise_faraday_errors: false
+                end
+
+                ##
+                # Baseline implementation for the list_experiments REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::ListExperimentsRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::ListExperimentsResponse]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::ListExperimentsResponse]
+                #   A result object deserialized from the server's reply
+                def list_experiments request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_list_experiments_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::ListExperimentsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the get_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::GetExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                #   A result object deserialized from the server's reply
+                def get_experiment request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_get_experiment_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Experiment.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the create_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::CreateExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                #   A result object deserialized from the server's reply
+                def create_experiment request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_create_experiment_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Experiment.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the update_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::UpdateExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                #   A result object deserialized from the server's reply
+                def update_experiment request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_update_experiment_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Experiment.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the delete_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::DeleteExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Protobuf::Empty]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Protobuf::Empty]
+                #   A result object deserialized from the server's reply
+                def delete_experiment request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_delete_experiment_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the start_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::StartExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                #   A result object deserialized from the server's reply
+                def start_experiment request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_start_experiment_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Experiment.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the stop_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::StopExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Experiment]
+                #   A result object deserialized from the server's reply
+                def stop_experiment request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_stop_experiment_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Experiment.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the list_experiments REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::ListExperimentsRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_list_experiments_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :get,
+                                                            uri_template: "/v3/{parent}/experiments",
+                                                            matches: [
+                                                              ["parent", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the get_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::GetExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_get_experiment_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :get,
+                                                            uri_template: "/v3/{name}",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the create_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::CreateExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_create_experiment_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{parent}/experiments",
+                                                            body: "experiment",
+                                                            matches: [
+                                                              ["parent", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the update_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::UpdateExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_update_experiment_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :patch,
+                                                            uri_template: "/v3/{experiment.name}",
+                                                            body: "experiment",
+                                                            matches: [
+                                                              ["experiment.name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the delete_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::DeleteExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_delete_experiment_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :delete,
+                                                            uri_template: "/v3/{name}",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the start_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::StartExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_start_experiment_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{name}:start",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the stop_experiment REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::StopExperimentRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_stop_experiment_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{name}:stop",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/cx/v3/experiments/rest.rb

@@ -0,0 +1,55 @@
+# 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/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/cx/v3/version"
+require "google/cloud/dialogflow/cx/v3/bindings_override"
+
+require "google/cloud/dialogflow/cx/v3/experiments/credentials"
+require "google/cloud/dialogflow/cx/v3/experiments/paths"
+require "google/cloud/dialogflow/cx/v3/experiments/rest/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          ##
+          # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiments}.
+          #
+          # To load this service and instantiate a REST client:
+          #
+          #     require "google/cloud/dialogflow/cx/v3/experiments/rest"
+          #     client = ::Google::Cloud::Dialogflow::CX::V3::Experiments::Rest::Client.new
+          #
+          module Experiments
+            # Client for the REST transport
+            module Rest
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/dialogflow/cx/v3/experiments/rest/helpers" if ::File.file? helper_path

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

@@ -25,6 +25,7 @@ require "google/cloud/dialogflow/cx/v3/version"
 require "google/cloud/dialogflow/cx/v3/experiments/credentials"
 require "google/cloud/dialogflow/cx/v3/experiments/paths"
 require "google/cloud/dialogflow/cx/v3/experiments/client"
+require "google/cloud/dialogflow/cx/v3/experiments/rest"
 
 module Google
   module Cloud
@@ -39,6 +40,11 @@ module Google
           #     require "google/cloud/dialogflow/cx/v3/experiments"
           #     client = ::Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new
           #
+          # @example Load this service and instantiate a REST client
+          #
+          #     require "google/cloud/dialogflow/cx/v3/experiments/rest"
+          #     client = ::Google::Cloud::Dialogflow::CX::V3::Experiments::Rest::Client.new
+          #
           module Experiments
           end
         end