Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Agents::Rest::ServiceStub (v1.1.1)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::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

#create_agent

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

Baseline implementation for the create_agent REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_agent

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

Baseline implementation for the delete_agent REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
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
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_agent

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

Baseline implementation for the get_agent REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_agent_validation_result

def get_agent_validation_result(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult

Baseline implementation for the get_agent_validation_result REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_generative_settings

def get_generative_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings

Baseline implementation for the get_generative_settings REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

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

#list_agents

def list_agents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::ListAgentsResponse

Baseline implementation for the list_agents REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#restore_agent

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

Baseline implementation for the restore_agent REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_agent

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

Baseline implementation for the update_agent REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_generative_settings

def update_generative_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings

Baseline implementation for the update_generative_settings REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#validate_agent

def validate_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult

Baseline implementation for the validate_agent REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)