Class: Google::Cloud::Dialogflow::CX::V3::Sessions::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb

Overview

REST service stub for the Sessions service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 34

def initialize endpoint:, endpoint_template:, universe_domain:, 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,
                                               endpoint_template: endpoint_template,
                                               universe_domain: universe_domain,
                                               credentials: credentials,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#detect_intent(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse

Baseline implementation for the detect_intent REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 79

def detect_intent request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_detect_intent_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::DetectIntentResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


61
62
63
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 61

def endpoint
  @client_stub.endpoint
end

#fulfill_intent(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse

Baseline implementation for the fulfill_intent REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 188

def fulfill_intent request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_fulfill_intent_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::FulfillIntentResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#match_intent(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse

Baseline implementation for the match_intent REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 150

def match_intent request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_match_intent_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::MatchIntentResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#server_streaming_detect_intent(request_pb, options = nil) {|chunk| ... } ⇒ ::Gapic::Rest::TransportOperation

Baseline implementation for the server_streaming_detect_intent REST call

Parameters:

Yield Parameters:

  • chunk (::String) —

    The chunk of data received during server streaming.

Returns:

  • (::Gapic::Rest::TransportOperation)

Raises:

  • (::ArgumentError) 


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 114

def server_streaming_detect_intent request_pb, options = nil, &block
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_server_streaming_detect_intent_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,
    is_server_streaming: true,
    &block
  )
  ::Gapic::Rest::TransportOperation.new response
end

#submit_answer_feedback(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback

Baseline implementation for the submit_answer_feedback REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 226

def submit_answer_feedback request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_submit_answer_feedback_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::AnswerFeedback.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


52
53
54
 
# File 'lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb', line 52

def universe_domain
  @client_stub.universe_domain
end