# 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/v2/agent_pb"
module Google
module Cloud
module Dialogflow
module V2
module Agents
module Rest
##
# REST service stub for the Agents 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 get_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::GetAgentRequest]
# 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::V2::Agent]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::Agent]
# A result object deserialized from the server's reply
def get_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_agent_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::V2::Agent.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the set_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::SetAgentRequest]
# 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::V2::Agent]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::Agent]
# A result object deserialized from the server's reply
def set_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_set_agent_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::V2::Agent.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the delete_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::DeleteAgentRequest]
# 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_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_delete_agent_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 search_agents REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::SearchAgentsRequest]
# 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::V2::SearchAgentsResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::SearchAgentsResponse]
# A result object deserialized from the server's reply
def search_agents request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_search_agents_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::V2::SearchAgentsResponse.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the train_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::TrainAgentRequest]
# 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::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def train_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_train_agent_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the export_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::ExportAgentRequest]
# 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::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def export_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_export_agent_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the import_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::ImportAgentRequest]
# 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::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def import_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_import_agent_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the restore_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::RestoreAgentRequest]
# 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::Longrunning::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Longrunning::Operation]
# A result object deserialized from the server's reply
def restore_agent request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_restore_agent_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# Baseline implementation for the get_validation_result REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::GetValidationResultRequest]
# 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::V2::ValidationResult]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::ValidationResult]
# A result object deserialized from the server's reply
def get_validation_result request_pb, options = nil
raise ::ArgumentError, "request must be provided" if request_pb.nil?
verb, uri, query_string_params, body = ServiceStub.transcode_get_validation_result_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::V2::ValidationResult.decode_json response.body, ignore_unknown_fields: true
yield result, operation if block_given?
result
end
##
# @private
#
# GRPC transcoding helper method for the get_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::GetAgentRequest]
# 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_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v2/{parent}/agent",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :get,
uri_template: "/v2/{parent}/agent",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the set_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::SetAgentRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_set_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v2/{agent.parent}/agent",
body: "agent",
matches: [
["agent.parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :post,
uri_template: "/v2/{agent.parent}/agent",
body: "agent",
matches: [
["agent.parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the delete_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::DeleteAgentRequest]
# 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_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :delete,
uri_template: "/v2/{parent}/agent",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :delete,
uri_template: "/v2/{parent}/agent",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the search_agents REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::SearchAgentsRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_search_agents_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v2/{parent}/agent:search",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :get,
uri_template: "/v2/{parent}/agent:search",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the train_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::TrainAgentRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_train_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:train",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:train",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the export_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::ExportAgentRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_export_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:export",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:export",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the import_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::ImportAgentRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_import_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:import",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:import",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the restore_agent REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::RestoreAgentRequest]
# A request object representing the call parameters. Required.
# @return [Array(String, [String, nil], Hash{String => String})]
# Uri, Body, Query string parameters
def self.transcode_restore_agent_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:restore",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :post,
uri_template: "/v2/{parent}/agent:restore",
body: "*",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
##
# @private
#
# GRPC transcoding helper method for the get_validation_result REST call
#
# @param request_pb [::Google::Cloud::Dialogflow::V2::GetValidationResultRequest]
# 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_validation_result_request request_pb
transcoder = Gapic::Rest::GrpcTranscoder.new
.with_bindings(
uri_method: :get,
uri_template: "/v2/{parent}/agent/validationResult",
matches: [
["parent", %r{^projects/[^/]+/?$}, false]
]
)
.with_bindings(
uri_method: :get,
uri_template: "/v2/{parent}/agent/validationResult",
matches: [
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
]
)
transcoder.transcode request_pb
end
end
end
end
end
end
end
end