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

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

#include <google/cloud/dialogflow_es/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::v2::Environment > ListEnvironments (std::string const &parent, Options opts={})
 Returns the list of all non-default environments of the specified agent. More...
 
StreamRange< google::cloud::dialogflow::v2::Environment > ListEnvironments (google::cloud::dialogflow::v2::ListEnvironmentsRequest request, Options opts={})
 Returns the list of all non-default environments of the specified agent. More...
 
StatusOr< google::cloud::dialogflow::v2::Environment > GetEnvironment (google::cloud::dialogflow::v2::GetEnvironmentRequest const &request, Options opts={})
 Retrieves the specified agent environment. More...
 
StatusOr< google::cloud::dialogflow::v2::Environment > CreateEnvironment (google::cloud::dialogflow::v2::CreateEnvironmentRequest const &request, Options opts={})
 Creates an agent environment. More...
 
StatusOr< google::cloud::dialogflow::v2::Environment > UpdateEnvironment (google::cloud::dialogflow::v2::UpdateEnvironmentRequest const &request, Options opts={})
 Updates the specified agent environment. More...
 
Status DeleteEnvironment (google::cloud::dialogflow::v2::DeleteEnvironmentRequest const &request, Options opts={})
 Deletes the specified agent environment. More...
 
StreamRange< google::cloud::dialogflow::v2::EnvironmentHistory::Entry > GetEnvironmentHistory (google::cloud::dialogflow::v2::GetEnvironmentHistoryRequest request, Options opts={})
 Gets the history of the specified 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.v2.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 61 of file environments_client.h.

Constructor & Destructor Documentation

◆ EnvironmentsClient() [1/3]

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

◆ ~EnvironmentsClient()

google::cloud::dialogflow_es::EnvironmentsClient::~EnvironmentsClient ( )

◆ EnvironmentsClient() [2/3]

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

◆ EnvironmentsClient() [3/3]

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

Member Function Documentation

◆ CreateEnvironment()

StatusOr<google::cloud::dialogflow::v2::Environment> google::cloud::dialogflow_es::EnvironmentsClient::CreateEnvironment ( google::cloud::dialogflow::v2::CreateEnvironmentRequest const &  request,
Options  opts = {} 
)

Creates an agent environment.

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

◆ DeleteEnvironment()

Status google::cloud::dialogflow_es::EnvironmentsClient::DeleteEnvironment ( google::cloud::dialogflow::v2::DeleteEnvironmentRequest const &  request,
Options  opts = {} 
)

Deletes the specified agent environment.

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

◆ GetEnvironment()

StatusOr<google::cloud::dialogflow::v2::Environment> google::cloud::dialogflow_es::EnvironmentsClient::GetEnvironment ( google::cloud::dialogflow::v2::GetEnvironmentRequest const &  request,
Options  opts = {} 
)

Retrieves the specified agent environment.

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

◆ GetEnvironmentHistory()

StreamRange<google::cloud::dialogflow::v2::EnvironmentHistory::Entry> google::cloud::dialogflow_es::EnvironmentsClient::GetEnvironmentHistory ( google::cloud::dialogflow::v2::GetEnvironmentHistoryRequest  request,
Options  opts = {} 
)

Gets the history of the specified environment.

Parameters
requestgoogle::cloud::dialogflow::v2::GetEnvironmentHistoryRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::EnvironmentHistory::Entry

◆ ListEnvironments() [1/2]

StreamRange<google::cloud::dialogflow::v2::Environment> google::cloud::dialogflow_es::EnvironmentsClient::ListEnvironments ( google::cloud::dialogflow::v2::ListEnvironmentsRequest  request,
Options  opts = {} 
)

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

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

◆ ListEnvironments() [2/2]

StreamRange<google::cloud::dialogflow::v2::Environment> google::cloud::dialogflow_es::EnvironmentsClient::ListEnvironments ( std::string const &  parent,
Options  opts = {} 
)

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

Parameters
parentRequired. The agent to list all environments from. Format:
  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Environment

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ UpdateEnvironment()

StatusOr<google::cloud::dialogflow::v2::Environment> google::cloud::dialogflow_es::EnvironmentsClient::UpdateEnvironment ( google::cloud::dialogflow::v2::UpdateEnvironmentRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::cloud::dialogflow::v2::UpdateEnvironmentRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::dialogflow::v2::Environment

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 81 of file environments_client.h.

◆ operator==

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

Definition at line 77 of file environments_client.h.