proto_docs/google/cloud/dialogflow/cx/v3/flow.rb in google-cloud-dialogflow-cx-v3-0.10.2 vs proto_docs/google/cloud/dialogflow/cx/v3/flow.rb in google-cloud-dialogflow-cx-v3-0.11.0

- old
+ new

@@ -121,13 +121,14 @@ # * They are inherited by every page's [event # handlers][Page.event_handlers], which can be used to handle common events # regardless of the current page. Event handlers defined in the page # have higher priority than those defined in the flow. # - # Unlike {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_routes transition_routes}, these handlers are - # evaluated on a first-match basis. The first one that matches the event - # get executed, with the rest being ignored. + # Unlike + # {::Google::Cloud::Dialogflow::CX::V3::Flow#transition_routes transition_routes}, + # these handlers are evaluated on a first-match basis. The first one that + # matches the event get executed, with the rest being ignored. # @!attribute [rw] transition_route_groups # @return [::Array<::String>] # A flow's transition route group serve two purposes: # # * They are responsible for matching the user's first utterances in the @@ -144,11 +145,12 @@ class Flow include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#create_flow Flows.CreateFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#create_flow Flows.CreateFlow}. # @!attribute [rw] parent # @return [::String] # Required. The agent to create a flow for. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. # @!attribute [rw] flow @@ -171,11 +173,12 @@ class CreateFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#delete_flow Flows.DeleteFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#delete_flow Flows.DeleteFlow}. # @!attribute [rw] name # @return [::String] # Required. The name of the flow to delete. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>`. @@ -194,11 +197,12 @@ class DeleteFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}. # @!attribute [rw] parent # @return [::String] # Required. The agent containing the flows. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. # @!attribute [rw] page_size @@ -226,11 +230,12 @@ class ListFlowsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}. + # The response message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#list_flows Flows.ListFlows}. # @!attribute [rw] flows # @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Flow>] # The list of flows. There will be a maximum number of items returned based # on the page_size field in the request. # @!attribute [rw] next_page_token @@ -240,11 +245,12 @@ class ListFlowsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow Flows.GetFlow}. + # The response message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow Flows.GetFlow}. # @!attribute [rw] name # @return [::String] # Required. The name of the flow to get. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>`. @@ -266,11 +272,12 @@ class GetFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#update_flow Flows.UpdateFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#update_flow Flows.UpdateFlow}. # @!attribute [rw] flow # @return [::Google::Cloud::Dialogflow::CX::V3::Flow] # Required. The flow to update. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] @@ -293,22 +300,24 @@ class UpdateFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#train_flow Flows.TrainFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#train_flow Flows.TrainFlow}. # @!attribute [rw] name # @return [::String] # Required. The flow to train. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>`. class TrainFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#validate_flow Flows.ValidateFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#validate_flow Flows.ValidateFlow}. # @!attribute [rw] name # @return [::String] # Required. The flow to validate. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>`. @@ -318,11 +327,12 @@ class ValidateFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}. # @!attribute [rw] name # @return [::String] # Required. The flow name. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>/validationResult`. @@ -332,11 +342,12 @@ class GetFlowValidationResultRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}. + # The response message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#get_flow_validation_result Flows.GetFlowValidationResult}. # @!attribute [rw] name # @return [::String] # The unique identifier of the flow validation result. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>/validationResult`. @@ -349,11 +360,12 @@ class FlowValidationResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}. # @!attribute [rw] parent # @return [::String] # Required. The agent to import the flow into. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. # @!attribute [rw] flow_uri @@ -392,33 +404,35 @@ # not available. FALLBACK = 2 end end - # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}. + # The response message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#import_flow Flows.ImportFlow}. # @!attribute [rw] flow # @return [::String] # The unique identifier of the new flow. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>`. class ImportFlowResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The request message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}. + # The request message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}. # @!attribute [rw] name # @return [::String] # Required. The name of the flow to export. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/flows/<Flow ID>`. # @!attribute [rw] flow_uri # @return [::String] - # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to - # export the flow to. The format of this URI must be - # `gs://<bucket-name>/<object-name>`. - # If left unspecified, the serialized flow is returned inline. + # Optional. The [Google Cloud + # Storage](https://cloud.google.com/storage/docs/) URI to export the flow to. + # The format of this URI must be `gs://<bucket-name>/<object-name>`. If left + # unspecified, the serialized flow is returned inline. # # Dialogflow performs a write operation for the Cloud Storage object # on the caller's behalf, so your request authentication must # have write permissions for the object. For more information, see # [Dialogflow access @@ -429,14 +443,16 @@ class ExportFlowRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # The response message for {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}. + # The response message for + # {::Google::Cloud::Dialogflow::CX::V3::Flows::Client#export_flow Flows.ExportFlow}. # @!attribute [rw] flow_uri # @return [::String] # The URI to a file containing the exported flow. This field is populated - # only if `flow_uri` is specified in {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest ExportFlowRequest}. + # only if `flow_uri` is specified in + # {::Google::Cloud::Dialogflow::CX::V3::ExportFlowRequest ExportFlowRequest}. # @!attribute [rw] flow_content # @return [::String] # Uncompressed raw byte content for flow. class ExportFlowResponse include ::Google::Protobuf::MessageExts