google::cloud::dialogflow_cx::ExperimentsClient Class Reference

Service for managing Experiments. More...

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

Public Member Functions
	ExperimentsClient (std::shared_ptr< ExperimentsConnection > connection, Options opts={})
	~ExperimentsClient ()
StreamRange< google::cloud::dialogflow::cx::v3::Experiment >	ListExperiments (std::string const &parent, Options opts={})
	Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment]. More...
StreamRange< google::cloud::dialogflow::cx::v3::Experiment >	ListExperiments (google::cloud::dialogflow::cx::v3::ListExperimentsRequest request, Options opts={})
	Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment]. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	GetExperiment (std::string const &name, Options opts={})
	Retrieves the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	GetExperiment (google::cloud::dialogflow::cx::v3::GetExperimentRequest const &request, Options opts={})
	Retrieves the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	CreateExperiment (std::string const &parent, google::cloud::dialogflow::cx::v3::Experiment const &experiment, Options opts={})
	Creates an Experiment in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment]. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	CreateExperiment (google::cloud::dialogflow::cx::v3::CreateExperimentRequest const &request, Options opts={})
	Creates an Experiment in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment]. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	UpdateExperiment (google::cloud::dialogflow::cx::v3::Experiment const &experiment, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	UpdateExperiment (google::cloud::dialogflow::cx::v3::UpdateExperimentRequest const &request, Options opts={})
	Updates the specified Experiment. More...
Status	DeleteExperiment (std::string const &name, Options opts={})
	Deletes the specified Experiment. More...
Status	DeleteExperiment (google::cloud::dialogflow::cx::v3::DeleteExperimentRequest const &request, Options opts={})
	Deletes the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	StartExperiment (std::string const &name, Options opts={})
	Starts the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	StartExperiment (google::cloud::dialogflow::cx::v3::StartExperimentRequest const &request, Options opts={})
	Starts the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	StopExperiment (std::string const &name, Options opts={})
	Stops the specified Experiment. More...
StatusOr< google::cloud::dialogflow::cx::v3::Experiment >	StopExperiment (google::cloud::dialogflow::cx::v3::StopExperimentRequest const &request, Options opts={})
	Stops the specified Experiment. More...
Copy and move support
	ExperimentsClient (ExperimentsClient const &)=default
ExperimentsClient &	operator= (ExperimentsClient const &)=default
	ExperimentsClient (ExperimentsClient &&)=default
ExperimentsClient &	operator= (ExperimentsClient &&)=default

Friends
Equality
bool	operator== (ExperimentsClient const &a, ExperimentsClient const &b)
bool	operator!= (ExperimentsClient const &a, ExperimentsClient const &b)

Detailed Description

Service for managing Experiments.

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.

Constructor & Destructor Documentation

ExperimentsClient() [1/3]

google::cloud::dialogflow_cx::ExperimentsClient::ExperimentsClient ( std::shared_ptr< ExperimentsConnection >  connection, Options  opts = {}  )

explicit

~ExperimentsClient()

google::cloud::dialogflow_cx::ExperimentsClient::~ExperimentsClient

(

)

ExperimentsClient() [2/3]

google::cloud::dialogflow_cx::ExperimentsClient::ExperimentsClient ( ExperimentsClient const &  )

default

ExperimentsClient() [3/3]

google::cloud::dialogflow_cx::ExperimentsClient::ExperimentsClient ( ExperimentsClient &&  )

default

Member Function Documentation

CreateExperiment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::CreateExperiment	(	google::cloud::dialogflow::cx::v3::CreateExperimentRequest const &	request,
		Options	opts = {}
	)

Creates an Experiment in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters

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

Returns

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

CreateExperiment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::CreateExperiment	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::Experiment const &	experiment,
		Options	opts = {}
	)

Creates an Experiment in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters

parent	Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.
experiment	Required. The experiment to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

DeleteExperiment() [1/2]

Status google::cloud::dialogflow_cx::ExperimentsClient::DeleteExperiment	(	google::cloud::dialogflow::cx::v3::DeleteExperimentRequest const &	request,
		Options	opts = {}
	)

Deletes the specified Experiment.

Parameters

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

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

DeleteExperiment() [2/2]

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

Deletes the specified Experiment.

Parameters

name	Required. 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>/experiments/<Experiment ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

a `Status` object. If the request failed, the status contains the details of the failure.

GetExperiment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::GetExperiment	(	google::cloud::dialogflow::cx::v3::GetExperimentRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified Experiment.

Parameters

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

Returns

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

GetExperiment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::GetExperiment	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified Experiment.

Parameters

name	Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

ListExperiments() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::ListExperiments	(	google::cloud::dialogflow::cx::v3::ListExperimentsRequest	request,
		Options	opts = {}
	)

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters

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

Returns

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

ListExperiments() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::ListExperiments	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all experiments in the specified [Environment][google.cloud.dialogflow.cx.v3.Environment].

Parameters

parent	Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments 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.

Returns

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

operator=() [1/2]

ExperimentsClient & google::cloud::dialogflow_cx::ExperimentsClient::operator= ( ExperimentsClient &&  )

default

operator=() [2/2]

ExperimentsClient & google::cloud::dialogflow_cx::ExperimentsClient::operator= ( ExperimentsClient const &  )

default

StartExperiment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::StartExperiment	(	google::cloud::dialogflow::cx::v3::StartExperimentRequest const &	request,
		Options	opts = {}
	)

Starts the specified Experiment.

This rpc only changes the state of experiment from PENDING to RUNNING.

Parameters

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

Returns

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

StartExperiment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::StartExperiment	(	std::string const &	name,
		Options	opts = {}
	)

Starts the specified Experiment.

This rpc only changes the state of experiment from PENDING to RUNNING.

Parameters

name	Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

StopExperiment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::StopExperiment	(	google::cloud::dialogflow::cx::v3::StopExperimentRequest const &	request,
		Options	opts = {}
	)

Stops the specified Experiment.

This rpc only changes the state of experiment from RUNNING to DONE.

Parameters

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

Returns

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

StopExperiment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::StopExperiment	(	std::string const &	name,
		Options	opts = {}
	)

Stops the specified Experiment.

This rpc only changes the state of experiment from RUNNING to DONE.

Parameters

name	Required. Resource name of the experiment to stop. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

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

UpdateExperiment() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::UpdateExperiment	(	google::cloud::dialogflow::cx::v3::Experiment const &	experiment,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified Experiment.

Parameters

experiment	Required. The experiment 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.

Returns

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

UpdateExperiment() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::Experiment > google::cloud::dialogflow_cx::ExperimentsClient::UpdateExperiment	(	google::cloud::dialogflow::cx::v3::UpdateExperimentRequest const &	request,
		Options	opts = {}
	)

Updates the specified Experiment.

Parameters

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

Returns

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

Friends And Related Function Documentation

operator!=

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

friend

operator==

bool operator== ( ExperimentsClient const &  a, ExperimentsClient const &  b  )

friend