google::cloud::dialogflow_cx::SessionEntityTypesClient Class Reference

Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType]. More...

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

Public Member Functions
	SessionEntityTypesClient (std::shared_ptr< SessionEntityTypesConnection > connection, Options opts={})
	~SessionEntityTypesClient ()
	SessionEntityTypesClient (SessionEntityTypesClient const &)=default
SessionEntityTypesClient &	operator= (SessionEntityTypesClient const &)=default
	SessionEntityTypesClient (SessionEntityTypesClient &&)=default
SessionEntityTypesClient &	operator= (SessionEntityTypesClient &&)=default
StreamRange< google::cloud::dialogflow::cx::v3::SessionEntityType >	ListSessionEntityTypes (std::string const &parent, Options opts={})
	Returns the list of all session entity types in the specified session. More...
StreamRange< google::cloud::dialogflow::cx::v3::SessionEntityType >	ListSessionEntityTypes (google::cloud::dialogflow::cx::v3::ListSessionEntityTypesRequest request, Options opts={})
	Returns the list of all session entity types in the specified session. More...
StatusOr< google::cloud::dialogflow::cx::v3::SessionEntityType >	GetSessionEntityType (std::string const &name, Options opts={})
	Retrieves the specified session entity type. More...
StatusOr< google::cloud::dialogflow::cx::v3::SessionEntityType >	GetSessionEntityType (google::cloud::dialogflow::cx::v3::GetSessionEntityTypeRequest const &request, Options opts={})
	Retrieves the specified session entity type. More...
StatusOr< google::cloud::dialogflow::cx::v3::SessionEntityType >	CreateSessionEntityType (std::string const &parent, google::cloud::dialogflow::cx::v3::SessionEntityType const &session_entity_type, Options opts={})
	Creates a session entity type. More...
StatusOr< google::cloud::dialogflow::cx::v3::SessionEntityType >	CreateSessionEntityType (google::cloud::dialogflow::cx::v3::CreateSessionEntityTypeRequest const &request, Options opts={})
	Creates a session entity type. More...
StatusOr< google::cloud::dialogflow::cx::v3::SessionEntityType >	UpdateSessionEntityType (google::cloud::dialogflow::cx::v3::SessionEntityType const &session_entity_type, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified session entity type. More...
StatusOr< google::cloud::dialogflow::cx::v3::SessionEntityType >	UpdateSessionEntityType (google::cloud::dialogflow::cx::v3::UpdateSessionEntityTypeRequest const &request, Options opts={})
	Updates the specified session entity type. More...
Status	DeleteSessionEntityType (std::string const &name, Options opts={})
	Deletes the specified session entity type. More...
Status	DeleteSessionEntityType (google::cloud::dialogflow::cx::v3::DeleteSessionEntityTypeRequest const &request, Options opts={})
	Deletes the specified session entity type. More...

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

Detailed Description

Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].

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 62 of file session_entity_types_client.h.

Constructor & Destructor Documentation

SessionEntityTypesClient() [1/3]

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

explicit

~SessionEntityTypesClient()

google::cloud::dialogflow_cx::SessionEntityTypesClient::~SessionEntityTypesClient

(

)

SessionEntityTypesClient() [2/3]

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

default

SessionEntityTypesClient() [3/3]

google::cloud::dialogflow_cx::SessionEntityTypesClient::SessionEntityTypesClient ( SessionEntityTypesClient &&  )

default

Member Function Documentation

CreateSessionEntityType() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::CreateSessionEntityType	(	google::cloud::dialogflow::cx::v3::CreateSessionEntityTypeRequest const &	request,
		Options	opts = {}
	)

Creates a session entity type.

Parameters

request	google::cloud::dialogflow::cx::v3::CreateSessionEntityTypeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

CreateSessionEntityType() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::CreateSessionEntityType	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::SessionEntityType const &	session_entity_type,
		Options	opts = {}
	)

Creates a session entity type.

Parameters

parent	Required. The session to create a session entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID> If Environment ID is not specified, we assume default 'draft' environment.
session_entity_type	Required. The session entity type to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

DeleteSessionEntityType() [1/2]

Status google::cloud::dialogflow_cx::SessionEntityTypesClient::DeleteSessionEntityType	(	google::cloud::dialogflow::cx::v3::DeleteSessionEntityTypeRequest const &	request,
		Options	opts = {}
	)

Deletes the specified session entity type.

Parameters

request	google::cloud::dialogflow::cx::v3::DeleteSessionEntityTypeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

DeleteSessionEntityType() [2/2]

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

Deletes the specified session entity type.

Parameters

name

Required. The name of the session entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> If Environment ID is not specified, we assume the default 'draft' environment.

opts

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

GetSessionEntityType() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::GetSessionEntityType	(	google::cloud::dialogflow::cx::v3::GetSessionEntityTypeRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified session entity type.

Parameters

request	google::cloud::dialogflow::cx::v3::GetSessionEntityTypeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

GetSessionEntityType() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::GetSessionEntityType	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified session entity type.

Parameters

name	Required. The name of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> If Environment ID is not specified, we assume the default 'draft' environment.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

ListSessionEntityTypes() [1/2]

StreamRange<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::ListSessionEntityTypes	(	google::cloud::dialogflow::cx::v3::ListSessionEntityTypesRequest	request,
		Options	opts = {}
	)

Returns the list of all session entity types in the specified session.

Parameters

request	google::cloud::dialogflow::cx::v3::ListSessionEntityTypesRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

ListSessionEntityTypes() [2/2]

StreamRange<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::ListSessionEntityTypes	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all session entity types in the specified session.

Parameters

parent	Required. The session to list all session entity types from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID> If Environment ID is not specified, we assume default 'draft' environment.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

operator=() [1/2]

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

default

operator=() [2/2]

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

default

UpdateSessionEntityType() [1/2]

StatusOr<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::UpdateSessionEntityType	(	google::cloud::dialogflow::cx::v3::SessionEntityType const &	session_entity_type,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified session entity type.

Parameters

session_entity_type	Required. The session entity type to update. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> If Environment ID is not specified, we assume the default 'draft' environment.
update_mask	The mask to control which fields get updated.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

UpdateSessionEntityType() [2/2]

StatusOr<google::cloud::dialogflow::cx::v3::SessionEntityType> google::cloud::dialogflow_cx::SessionEntityTypesClient::UpdateSessionEntityType	(	google::cloud::dialogflow::cx::v3::UpdateSessionEntityTypeRequest const &	request,
		Options	opts = {}
	)

Updates the specified session entity type.

Parameters

request	google::cloud::dialogflow::cx::v3::UpdateSessionEntityTypeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::dialogflow::cx::v3::SessionEntityType

Friends And Related Function Documentation

operator!=

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

friend

Definition at line 84 of file session_entity_types_client.h.

operator==

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

friend

Definition at line 80 of file session_entity_types_client.h.