Dialogflow API C++ Client 2.13.0
A C++ Client Library for the Dialogflow API
|
Service for managing Environments. More...
#include <google/cloud/dialogflow_cx/environments_client.h>
Public Member Functions | |
EnvironmentsClient (std::shared_ptr< EnvironmentsConnection > connection, Options opts={}) | |
~EnvironmentsClient () | |
StreamRange< google::cloud::dialogflow::cx::v3::Environment > | ListEnvironments (std::string const &parent, Options opts={}) |
Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More... | |
StreamRange< google::cloud::dialogflow::cx::v3::Environment > | ListEnvironments (google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest request, Options opts={}) |
Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More... | |
StatusOr< google::cloud::dialogflow::cx::v3::Environment > | GetEnvironment (std::string const &name, Options opts={}) |
Retrieves the specified Environment. More... | |
StatusOr< google::cloud::dialogflow::cx::v3::Environment > | GetEnvironment (google::cloud::dialogflow::cx::v3::GetEnvironmentRequest const &request, Options opts={}) |
Retrieves the specified Environment. More... | |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > | CreateEnvironment (std::string const &parent, google::cloud::dialogflow::cx::v3::Environment const &environment, Options opts={}) |
Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More... | |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > | CreateEnvironment (google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest const &request, Options opts={}) |
Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent]. More... | |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > | UpdateEnvironment (google::cloud::dialogflow::cx::v3::Environment const &environment, google::protobuf::FieldMask const &update_mask, Options opts={}) |
Updates the specified Environment. More... | |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > | UpdateEnvironment (google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest const &request, Options opts={}) |
Updates the specified Environment. More... | |
Status | DeleteEnvironment (std::string const &name, Options opts={}) |
Deletes the specified Environment. More... | |
Status | DeleteEnvironment (google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const &request, Options opts={}) |
Deletes the specified Environment. More... | |
StreamRange< google::cloud::dialogflow::cx::v3::Environment > | LookupEnvironmentHistory (std::string const &name, Options opts={}) |
Looks up the history of the specified Environment. More... | |
StreamRange< google::cloud::dialogflow::cx::v3::Environment > | LookupEnvironmentHistory (google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest request, Options opts={}) |
Looks up the history of the specified Environment. More... | |
future< StatusOr< google::cloud::dialogflow::cx::v3::RunContinuousTestResponse > > | RunContinuousTest (google::cloud::dialogflow::cx::v3::RunContinuousTestRequest const &request, Options opts={}) |
Kicks off a continuous test under the specified Environment. More... | |
StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult > | ListContinuousTestResults (std::string const &parent, Options opts={}) |
Fetches a list of continuous test results for a given environment. More... | |
StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult > | ListContinuousTestResults (google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest request, Options opts={}) |
Fetches a list of continuous test results for a given environment. More... | |
future< StatusOr< google::cloud::dialogflow::cx::v3::DeployFlowResponse > > | DeployFlow (google::cloud::dialogflow::cx::v3::DeployFlowRequest const &request, Options opts={}) |
Deploys a flow to the specified Environment. More... | |
Copy and move support | |
EnvironmentsClient (EnvironmentsClient const &)=default | |
EnvironmentsClient & | operator= (EnvironmentsClient const &)=default |
EnvironmentsClient (EnvironmentsClient &&)=default | |
EnvironmentsClient & | operator= (EnvironmentsClient &&)=default |
Friends | |
Equality | |
bool | operator== (EnvironmentsClient const &a, EnvironmentsClient const &b) |
bool | operator!= (EnvironmentsClient const &a, EnvironmentsClient const &b) |
Service for managing Environments.
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.
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.
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.
|
explicit |
google::cloud::dialogflow_cx::EnvironmentsClient::~EnvironmentsClient | ( | ) |
|
default |
|
default |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::CreateEnvironment | ( | google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest const & | request, |
Options | opts = {} |
||
) |
Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: Environmentrequest | 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.CreateEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::CreateEnvironment | ( | std::string const & | parent, |
google::cloud::dialogflow::cx::v3::Environment const & | environment, | ||
Options | opts = {} |
||
) |
Creates an Environment in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: Environmentparent | Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an Environment for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> . |
environment | Required. The environment to create. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
Status google::cloud::dialogflow_cx::EnvironmentsClient::DeleteEnvironment | ( | google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const & | request, |
Options | opts = {} |
||
) |
Deletes the specified Environment.
request | 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.DeleteEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
Status google::cloud::dialogflow_cx::EnvironmentsClient::DeleteEnvironment | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Deletes the specified Environment.
name | Required. The name of the Environment to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID> . |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::cx::v3::DeployFlowResponse > > google::cloud::dialogflow_cx::EnvironmentsClient::DeployFlow | ( | google::cloud::dialogflow::cx::v3::DeployFlowRequest const & | request, |
Options | opts = {} |
||
) |
Deploys a flow to the specified Environment.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: DeployFlowMetadataresponse
: DeployFlowResponserequest | 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.DeployFlowRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::GetEnvironment | ( | google::cloud::dialogflow::cx::v3::GetEnvironmentRequest const & | request, |
Options | opts = {} |
||
) |
Retrieves the specified Environment.
request | 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.GetEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StatusOr< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::GetEnvironment | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Retrieves the specified Environment.
name | Required. The name of the Environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID> . |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult > google::cloud::dialogflow_cx::EnvironmentsClient::ListContinuousTestResults | ( | google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest | request, |
Options | opts = {} |
||
) |
Fetches a list of continuous test results for a given environment.
request | 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.ListContinuousTestResultsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.ContinuousTestResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult > google::cloud::dialogflow_cx::EnvironmentsClient::ListContinuousTestResults | ( | std::string const & | parent, |
Options | opts = {} |
||
) |
Fetches a list of continuous test results for a given environment.
parent | Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID> . |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.ContinuousTestResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::ListEnvironments | ( | google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest | request, |
Options | opts = {} |
||
) |
Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
request | 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.ListEnvironmentsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::ListEnvironments | ( | std::string const & | parent, |
Options | opts = {} |
||
) |
Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].
parent | Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> . |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::LookupEnvironmentHistory | ( | google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest | request, |
Options | opts = {} |
||
) |
Looks up the history of the specified Environment.
request | 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.LookupEnvironmentHistoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules. StreamRange< google::cloud::dialogflow::cx::v3::Environment > google::cloud::dialogflow_cx::EnvironmentsClient::LookupEnvironmentHistory | ( | std::string const & | name, |
Options | opts = {} |
||
) |
Looks up the history of the specified Environment.
name | Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>
|
opts | Optional. Override the class-level options, such as retry and backoff policies. |
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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.
|
default |
|
default |
future< StatusOr< google::cloud::dialogflow::cx::v3::RunContinuousTestResponse > > google::cloud::dialogflow_cx::EnvironmentsClient::RunContinuousTest | ( | google::cloud::dialogflow::cx::v3::RunContinuousTestRequest const & | request, |
Options | opts = {} |
||
) |
Kicks off a continuous test under the specified Environment.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: RunContinuousTestMetadataresponse
: RunContinuousTestResponserequest | 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.RunContinuousTestRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::UpdateEnvironment | ( | google::cloud::dialogflow::cx::v3::Environment const & | environment, |
google::protobuf::FieldMask const & | update_mask, | ||
Options | opts = {} |
||
) |
Updates the specified Environment.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: Environmentenvironment | Required. The environment to update. |
update_mask | Required. The mask to control which fields get updated. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > > google::cloud::dialogflow_cx::EnvironmentsClient::UpdateEnvironment | ( | google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest const & | request, |
Options | opts = {} |
||
) |
Updates the specified Environment.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
: Environmentrequest | 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.UpdateEnvironmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules. |
opts | Optional. Override the class-level options, such as retry and backoff policies. |
|
friend |
|
friend |