Class EnvironmentsClient (2.29.0-rc)

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 non-default environments of the specified agent.

Parameters
Name Description
parent std::string const &

Required. The agent to list all environments from. Format:

opts Options

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

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::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.v2.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::v2::ListEnvironmentsRequest, Options)

Returns the list of all non-default environments of the specified agent.

Parameters
Name Description
request google::cloud::dialogflow::v2::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.v2.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::v2::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.v2.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(google::cloud::dialogflow::v2::GetEnvironmentRequest const &, Options)

Retrieves the specified agent environment.

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

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

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

Creates an agent environment.

Parameters
Name Description
request google::cloud::dialogflow::v2::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.v2.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
StatusOr< google::cloud::dialogflow::v2::Environment >

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

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

Updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters
Name Description
request google::cloud::dialogflow::v2::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.v2.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
StatusOr< google::cloud::dialogflow::v2::Environment >

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

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

Deletes the specified agent environment.

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

GetEnvironmentHistory(google::cloud::dialogflow::v2::GetEnvironmentHistoryRequest, Options)

Gets the history of the specified environment.

Parameters
Name Description
request google::cloud::dialogflow::v2::GetEnvironmentHistoryRequest

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.v2.GetEnvironmentHistoryRequest. 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::v2::EnvironmentHistory::Entry >

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