Class FlowsClient (2.20.0)

Version 2.20.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service for managing Flows.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

FlowsClient(FlowsClient const &)

Copy and move support

Parameter
Name	Description
	FlowsClient const &

FlowsClient(FlowsClient &&)

Copy and move support

Parameter
Name	Description
	FlowsClient &&

FlowsClient(std::shared_ptr< FlowsConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< FlowsConnection >
opts	Options

Operators

operator=(FlowsClient const &)

Copy and move support

Parameter
Name	Description
	FlowsClient const &

Returns
Type	Description
FlowsClient &

operator=(FlowsClient &&)

Copy and move support

Parameter
Name	Description
	FlowsClient &&

Returns
Type	Description
FlowsClient &

Functions

CreateFlow(std::string const &, google::cloud::dialogflow::cx::v3::Flow const &, Options)

Creates a flow in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
parent	std::string const & Required. The agent to create a flow for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
flow	google::cloud::dialogflow::cx::v3::Flow const & Required. The flow to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Flow >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Flow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateFlow(google::cloud::dialogflow::cx::v3::CreateFlowRequest const &, Options)

Creates a flow in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::CreateFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.CreateFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Flow >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Flow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteFlow(std::string const &, Options)

Deletes a specified flow.

Parameters
Name	Description
name	std::string const & Required. The name of the flow to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteFlow(google::cloud::dialogflow::cx::v3::DeleteFlowRequest const &, Options)

Deletes a specified flow.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::DeleteFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.DeleteFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

ListFlows(std::string const &, Options)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
parent	std::string const & Required. The agent containing the flows. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Flow >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.Flow, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFlows(google::cloud::dialogflow::cx::v3::ListFlowsRequest, Options)

Returns the list of all flows in the specified agent.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ListFlowsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ListFlowsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dialogflow::cx::v3::Flow >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.cx.v3.Flow, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetFlow(std::string const &, Options)

Retrieves the specified flow.

Parameters
Name	Description
name	std::string const & Required. The name of the flow to get. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Flow >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Flow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFlow(google::cloud::dialogflow::cx::v3::GetFlowRequest const &, Options)

Retrieves the specified flow.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.GetFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Flow >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Flow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateFlow(google::cloud::dialogflow::cx::v3::Flow const &, google::protobuf::FieldMask const &, Options)

Updates the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
flow	google::cloud::dialogflow::cx::v3::Flow const & Required. The flow to update.
update_mask	google::protobuf::FieldMask const & The mask to control which fields get updated. If the mask is not present, all fields will be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Flow >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Flow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateFlow(google::cloud::dialogflow::cx::v3::UpdateFlowRequest const &, Options)

Updates the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::UpdateFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.UpdateFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::Flow >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Flow) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TrainFlow(std::string const &, Options)

Trains the specified flow.

Note that only the flow in 'draft' environment is trained.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: An Empty message

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
name	std::string const & Required. The flow to train. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::protobuf::Struct > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

TrainFlow(google::cloud::dialogflow::cx::v3::TrainFlowRequest const &, Options)

Trains the specified flow.

Note that only the flow in 'draft' environment is trained.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: An Empty message

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::TrainFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.TrainFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::protobuf::Struct > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.protobuf.Struct proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ValidateFlow(google::cloud::dialogflow::cx::v3::ValidateFlowRequest const &, Options)

Validates the specified flow and creates or updates validation results.

Please call this API after the training is completed to get the complete validation results.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ValidateFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ValidateFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::FlowValidationResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.FlowValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFlowValidationResult(std::string const &, Options)

Gets the latest flow validation result.

Flow validation is performed when ValidateFlow is called.

Parameters
Name	Description
name	std::string const & Required. The flow name. Format: projects/<ProjectID>/locations/<LocationID>/agents/<Agent ID>/flows/<Flow ID>/validationResult.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::FlowValidationResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.FlowValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFlowValidationResult(google::cloud::dialogflow::cx::v3::GetFlowValidationResultRequest const &, Options)

Gets the latest flow validation result.

Flow validation is performed when ValidateFlow is called.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::GetFlowValidationResultRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.GetFlowValidationResultRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::dialogflow::cx::v3::FlowValidationResult >	the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.FlowValidationResult) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportFlow(google::cloud::dialogflow::cx::v3::ImportFlowRequest const &, Options)

Imports the specified flow to the specified agent from a binary file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: ImportFlowResponse

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ImportFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ImportFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::ImportFlowResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ImportFlowResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ExportFlow(google::cloud::dialogflow::cx::v3::ExportFlowRequest const &, Options)

Exports the specified flow to a binary file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: ExportFlowResponse

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

Parameters
Name	Description
request	google::cloud::dialogflow::cx::v3::ExportFlowRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.cx.v3.ExportFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dialogflow::cx::v3::ExportFlowResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dialogflow.cx.v3.ExportFlowResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.