Class EnvironmentsClient (2.11.0)

Service for managing Environments.

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

EnvironmentsClient(EnvironmentsClient const &)

Copy and move support

Parameter
Name Description
EnvironmentsClient const &

EnvironmentsClient(EnvironmentsClient &&)

Copy and move support

Parameter
Name Description
EnvironmentsClient &&

EnvironmentsClient(std::shared_ptr< EnvironmentsConnection >, Options)

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

Operators

operator=(EnvironmentsClient const &)

Copy and move support

Parameter
Name Description
EnvironmentsClient const &
Returns
Type Description
EnvironmentsClient &

operator=(EnvironmentsClient &&)

Copy and move support

Parameter
Name Description
EnvironmentsClient &&
Returns
Type Description
EnvironmentsClient &

Functions

ListEnvironments(std::string const &, Options)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
parent std::string const &

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<ProjectID>/locations/<Location ID>/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::Environment >

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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEnvironments(google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest, Options)

Returns the list of all environments in the specified [Agent][google.cloud.dialogflow.cx.v3.Agent].

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::ListEnvironmentsRequest

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::cx::v3::Environment >

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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEnvironment(std::string const &, Options)

Retrieves the specified Environment.

Parameters
Name Description
name std::string const &

Required. The name of the Environment. Format: projects/<ProjectID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::cx::v3::Environment >

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

GetEnvironment(google::cloud::dialogflow::cx::v3::GetEnvironmentRequest const &, Options)

Retrieves the specified Environment.

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::GetEnvironmentRequest 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.GetEnvironmentRequest. 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::Environment >

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

CreateEnvironment(std::string const &, google::cloud::dialogflow::cx::v3::Environment const &, Options)

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:

Parameters
Name Description
parent std::string const &

Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an Environment for. Format: projects/<ProjectID>/locations/<Location ID>/agents/<Agent ID>.

environment google::cloud::dialogflow::cx::v3::Environment const &

Required. The environment to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > >

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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEnvironment(google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest const &, Options)

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:

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::CreateEnvironmentRequest 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.CreateEnvironmentRequest. 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::Environment > >

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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateEnvironment(google::cloud::dialogflow::cx::v3::Environment const &, google::protobuf::FieldMask const &, Options)

Updates the specified Environment.

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

Parameters
Name Description
environment google::cloud::dialogflow::cx::v3::Environment const &

Required. The environment to update.

update_mask google::protobuf::FieldMask const &

Required. The mask to control which fields get updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::dialogflow::cx::v3::Environment > >

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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateEnvironment(google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest const &, Options)

Updates the specified Environment.

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

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest 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.UpdateEnvironmentRequest. 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::Environment > >

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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteEnvironment(std::string const &, Options)

Deletes the specified Environment.

Parameters
Name Description
name std::string const &

Required. The name of the Environment to delete. Format: projects/<ProjectID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment 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.

DeleteEnvironment(google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const &, Options)

Deletes the specified Environment.

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest 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.DeleteEnvironmentRequest. 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.

LookupEnvironmentHistory(std::string const &, Options)

Looks up the history of the specified Environment.

Parameters
Name Description
name std::string const &

Required. Resource name of the environment to look up the history for. Format:
```cpp projects/
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::cx::v3::Environment >

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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

LookupEnvironmentHistory(google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest, Options)

Looks up the history of the specified Environment.

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::cx::v3::Environment >

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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

RunContinuousTest(google::cloud::dialogflow::cx::v3::RunContinuousTestRequest const &, Options)

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:

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::RunContinuousTestRequest 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.RunContinuousTestRequest. 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::RunContinuousTestResponse > >

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.RunContinuousTestResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListContinuousTestResults(std::string const &, Options)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
parent std::string const &

Required. The environment to list results for. Format: projects/<ProjectID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult >

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.ContinuousTestResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListContinuousTestResults(google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest, Options)

Fetches a list of continuous test results for a given environment.

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest

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 Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::cx::v3::ContinuousTestResult >

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.ContinuousTestResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeployFlow(google::cloud::dialogflow::cx::v3::DeployFlowRequest const &, Options)

Deploys a flow to the specified Environment.

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

Parameters
Name Description
request google::cloud::dialogflow::cx::v3::DeployFlowRequest 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.DeployFlowRequest. 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::DeployFlowResponse > >

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.DeployFlowResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.