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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::CreateAgentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::Agent)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::Agent) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_agent
def delete_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_agent REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Protobuf::Empty) — A result object deserialized from the server's reply
- (::ArgumentError)
#export_agent
def export_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the export_agent REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::Agent)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::Agent) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::GetAgentValidationResultRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::GetGenerativeSettingsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::ListAgentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::ListAgentsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::ListAgentsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#restore_agent
def restore_agent(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the restore_agent REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::UpdateAgentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::Agent)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::Agent) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::UpdateGenerativeSettingsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Dialogflow::CX::V3::ValidateAgentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::AgentValidationResult) — A result object deserialized from the server's reply
- (::ArgumentError)