Dialogflow API C++ Client  2.2.1
A C++ Client Library for the Dialogflow API
Public Member Functions | Friends | List of all members
google::cloud::dialogflow_cx::EnvironmentsClient Class Reference

Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment]. More...

#include <google/cloud/dialogflow_cx/environments_client.h>

Public Member Functions

 EnvironmentsClient (std::shared_ptr< EnvironmentsConnection > connection, Options opts={})
 
 ~EnvironmentsClient ()
 
 EnvironmentsClient (EnvironmentsClient const &)=default
 
EnvironmentsClientoperator= (EnvironmentsClient const &)=default
 
 EnvironmentsClient (EnvironmentsClient &&)=default
 
EnvironmentsClientoperator= (EnvironmentsClient &&)=default
 
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][google.cloud.dialogflow.cx.v3.Environment]. More...
 
Status DeleteEnvironment (google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const &request, Options opts={})
 Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.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][google.cloud.dialogflow.cx.v3.Environment]. More...
 

Friends

bool operator== (EnvironmentsClient const &a, EnvironmentsClient const &b)
 
bool operator!= (EnvironmentsClient const &a, EnvironmentsClient const &b)
 

Detailed Description

Service for managing [Environments][google.cloud.dialogflow.cx.v3.Environment].

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.

Definition at line 63 of file environments_client.h.

Constructor & Destructor Documentation

◆ EnvironmentsClient() [1/3]

google::cloud::dialogflow_cx::EnvironmentsClient::EnvironmentsClient ( std::shared_ptr< EnvironmentsConnection connection,
Options  opts = {} 
)
explicit

◆ ~EnvironmentsClient()

google::cloud::dialogflow_cx::EnvironmentsClient::~EnvironmentsClient ( )

◆ EnvironmentsClient() [2/3]

google::cloud::dialogflow_cx::EnvironmentsClient::EnvironmentsClient ( EnvironmentsClient const &  )
default

◆ EnvironmentsClient() [3/3]

google::cloud::dialogflow_cx::EnvironmentsClient::EnvironmentsClient ( EnvironmentsClient &&  )
default

Member Function Documentation

◆ CreateEnvironment() [1/2]

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:

Parameters
requestgoogle::cloud::dialogflow::cx::v3::CreateEnvironmentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ CreateEnvironment() [2/2]

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:

Parameters
parentRequired. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an Environment for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
environmentRequired. The environment to create.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ DeleteEnvironment() [1/2]

Status google::cloud::dialogflow_cx::EnvironmentsClient::DeleteEnvironment ( google::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest const &  request,
Options  opts = {} 
)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
requestgoogle::cloud::dialogflow::cx::v3::DeleteEnvironmentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeleteEnvironment() [2/2]

Status google::cloud::dialogflow_cx::EnvironmentsClient::DeleteEnvironment ( std::string const &  name,
Options  opts = {} 
)

Deletes the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters
nameRequired. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.

◆ DeployFlow()

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][google.cloud.dialogflow.cx.v3.Environment].

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

  • metadata: [DeployFlowMetadata][google.cloud.dialogflow.cx.v3.DeployFlowMetadata]
  • response: DeployFlowResponse
Parameters
requestgoogle::cloud::dialogflow::cx::v3::DeployFlowRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::DeployFlowResponse

◆ GetEnvironment() [1/2]

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.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::GetEnvironmentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ GetEnvironment() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::Environment> google::cloud::dialogflow_cx::EnvironmentsClient::GetEnvironment ( std::string const &  name,
Options  opts = {} 
)

Retrieves the specified Environment.

Parameters
nameRequired. The name of the Environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ ListContinuousTestResults() [1/2]

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.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ListContinuousTestResultsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::ContinuousTestResult

◆ ListContinuousTestResults() [2/2]

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.

Parameters
parentRequired. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::ContinuousTestResult

◆ ListEnvironments() [1/2]

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].

Parameters
requestgoogle::cloud::dialogflow::cx::v3::ListEnvironmentsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ ListEnvironments() [2/2]

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].

Parameters
parentRequired. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ LookupEnvironmentHistory() [1/2]

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.

Parameters
requestgoogle::cloud::dialogflow::cx::v3::LookupEnvironmentHistoryRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ LookupEnvironmentHistory() [2/2]

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.

Parameters
nameRequired. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ operator=() [1/2]

EnvironmentsClient& google::cloud::dialogflow_cx::EnvironmentsClient::operator= ( EnvironmentsClient &&  )
default

◆ operator=() [2/2]

EnvironmentsClient& google::cloud::dialogflow_cx::EnvironmentsClient::operator= ( EnvironmentsClient const &  )
default

◆ RunContinuousTest()

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][google.cloud.dialogflow.cx.v3.Environment].

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

  • metadata: [RunContinuousTestMetadata][google.cloud.dialogflow.cx.v3.RunContinuousTestMetadata]
  • response: RunContinuousTestResponse
Parameters
requestgoogle::cloud::dialogflow::cx::v3::RunContinuousTestRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::RunContinuousTestResponse

◆ UpdateEnvironment() [1/2]

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:

Parameters
environmentRequired. The environment to update.
update_maskRequired. The mask to control which fields get updated.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

◆ UpdateEnvironment() [2/2]

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:

Parameters
requestgoogle::cloud::dialogflow::cx::v3::UpdateEnvironmentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::cx::v3::Environment

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( EnvironmentsClient const &  a,
EnvironmentsClient const &  b 
)
friend

Definition at line 83 of file environments_client.h.

◆ operator==

bool operator== ( EnvironmentsClient const &  a,
EnvironmentsClient const &  b 
)
friend

Definition at line 79 of file environments_client.h.