Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Flows::Rest::ServiceStub.
REST service stub for the Flows service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#create_flow
def create_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::Flow
Baseline implementation for the create_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::CreateFlowRequest) — 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::Flow)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::Flow) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_flow
def delete_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty
Baseline implementation for the delete_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::DeleteFlowRequest) — 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)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#export_flow
def export_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the export_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest) — 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_flow
def get_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::Flow
Baseline implementation for the get_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::GetFlowRequest) — 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::Flow)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::Flow) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_flow_validation_result
def get_flow_validation_result(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult
Baseline implementation for the get_flow_validation_result REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::GetFlowValidationResultRequest) — 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::FlowValidationResult)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult) — A result object deserialized from the server's reply
- (::ArgumentError)
#import_flow
def import_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the import_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::ImportFlowRequest) — 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)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_flows
def list_flows(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::ListFlowsResponse
Baseline implementation for the list_flows REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::ListFlowsRequest) — 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::ListFlowsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::ListFlowsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#train_flow
def train_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the train_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::TrainFlowRequest) — 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)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_flow
def update_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::Flow
Baseline implementation for the update_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::UpdateFlowRequest) — 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::Flow)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::Flow) — A result object deserialized from the server's reply
- (::ArgumentError)
#validate_flow
def validate_flow(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult
Baseline implementation for the validate_flow REST call
- request_pb (::Google::Cloud::Dialogflow::CX::V3::ValidateFlowRequest) — 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::FlowValidationResult)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Dialogflow::CX::V3::FlowValidationResult) — A result object deserialized from the server's reply
- (::ArgumentError)