Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Agents::Rest::ServiceStub (v1.0.0)

Version 1.0.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.0
• 0.34.0
• 0.33.0
• 0.32.2
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.0
• 0.15.2
• 0.14.0
• 0.13.0
• 0.12.0

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Agents::Rest::ServiceStub.

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

Inherits

• Object

Methods

#delete_agent

def delete_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::DeleteAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#export_agent

def export_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the export_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ExportAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_agent

def get_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::Agent

Baseline implementation for the get_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::GetAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Dialogflow::V2::Agent)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::Agent) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_validation_result

def get_validation_result(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::ValidationResult

Baseline implementation for the get_validation_result REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::GetValidationResultRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Dialogflow::V2::ValidationResult)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::ValidationResult) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#import_agent

def import_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the import_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::ImportAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#restore_agent

def restore_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the restore_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::RestoreAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#search_agents

def search_agents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::SearchAgentsResponse

Baseline implementation for the search_agents REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::SearchAgentsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Dialogflow::V2::SearchAgentsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::SearchAgentsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#set_agent

def set_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::V2::Agent

Baseline implementation for the set_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::SetAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Dialogflow::V2::Agent)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Dialogflow::V2::Agent) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#train_agent

def train_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the train_agent REST call

Parameters

• request_pb (::Google::Cloud::Dialogflow::V2::TrainAgentRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)