google::cloud::dialogflow_cx::SecuritySettingsServiceClient Class Reference

Service for managing security settings for Dialogflow. More...

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

Public Member Functions
	SecuritySettingsServiceClient (std::shared_ptr< SecuritySettingsServiceConnection > connection, Options opts={})
	~SecuritySettingsServiceClient ()
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings >	CreateSecuritySettings (std::string const &parent, google::cloud::dialogflow::cx::v3::SecuritySettings const &security_settings, Options opts={})
	Create security settings in the specified location. More...
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings >	CreateSecuritySettings (google::cloud::dialogflow::cx::v3::CreateSecuritySettingsRequest const &request, Options opts={})
	Create security settings in the specified location. More...
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings >	GetSecuritySettings (std::string const &name, Options opts={})
	Retrieves the specified SecuritySettings. More...
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings >	GetSecuritySettings (google::cloud::dialogflow::cx::v3::GetSecuritySettingsRequest const &request, Options opts={})
	Retrieves the specified SecuritySettings. More...
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings >	UpdateSecuritySettings (google::cloud::dialogflow::cx::v3::SecuritySettings const &security_settings, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates the specified SecuritySettings. More...
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings >	UpdateSecuritySettings (google::cloud::dialogflow::cx::v3::UpdateSecuritySettingsRequest const &request, Options opts={})
	Updates the specified SecuritySettings. More...
StreamRange< google::cloud::dialogflow::cx::v3::SecuritySettings >	ListSecuritySettings (std::string const &parent, Options opts={})
	Returns the list of all security settings in the specified location. More...
StreamRange< google::cloud::dialogflow::cx::v3::SecuritySettings >	ListSecuritySettings (google::cloud::dialogflow::cx::v3::ListSecuritySettingsRequest request, Options opts={})
	Returns the list of all security settings in the specified location. More...
Status	DeleteSecuritySettings (std::string const &name, Options opts={})
	Deletes the specified SecuritySettings. More...
Status	DeleteSecuritySettings (google::cloud::dialogflow::cx::v3::DeleteSecuritySettingsRequest const &request, Options opts={})
	Deletes the specified SecuritySettings. More...
Copy and move support
	SecuritySettingsServiceClient (SecuritySettingsServiceClient const &)=default
SecuritySettingsServiceClient &	operator= (SecuritySettingsServiceClient const &)=default
	SecuritySettingsServiceClient (SecuritySettingsServiceClient &&)=default
SecuritySettingsServiceClient &	operator= (SecuritySettingsServiceClient &&)=default

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

Detailed Description

Service for managing security settings for Dialogflow.

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

SecuritySettingsServiceClient() [1/3]

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

explicit

~SecuritySettingsServiceClient()

google::cloud::dialogflow_cx::SecuritySettingsServiceClient::~SecuritySettingsServiceClient

(

)

SecuritySettingsServiceClient() [2/3]

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

default

SecuritySettingsServiceClient() [3/3]

google::cloud::dialogflow_cx::SecuritySettingsServiceClient::SecuritySettingsServiceClient ( SecuritySettingsServiceClient &&  )

default

Member Function Documentation

CreateSecuritySettings() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::CreateSecuritySettings	(	google::cloud::dialogflow::cx::v3::CreateSecuritySettingsRequest const &	request,
		Options	opts = {}
	)

Create security settings in the specified location.

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.CreateSecuritySettingsRequest. 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.SecuritySettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateSecuritySettings() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::CreateSecuritySettings	(	std::string const &	parent,
		google::cloud::dialogflow::cx::v3::SecuritySettings const &	security_settings,
		Options	opts = {}
	)

Create security settings in the specified location.

Parameters

parent	Required. The location to create an SecuritySettings for. Format: projects/<Project ID>/locations/<Location ID>.
security_settings	Required. The security settings 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.SecuritySettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteSecuritySettings() [1/2]

Status google::cloud::dialogflow_cx::SecuritySettingsServiceClient::DeleteSecuritySettings	(	google::cloud::dialogflow::cx::v3::DeleteSecuritySettingsRequest const &	request,
		Options	opts = {}
	)

Deletes the specified SecuritySettings.

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

DeleteSecuritySettings() [2/2]

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

Deletes the specified SecuritySettings.

Parameters

name	Required. The name of the SecuritySettings to delete. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings 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.

GetSecuritySettings() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::GetSecuritySettings	(	google::cloud::dialogflow::cx::v3::GetSecuritySettingsRequest const &	request,
		Options	opts = {}
	)

Retrieves the specified SecuritySettings.

The returned settings may be stale by up to 1 minute.

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.GetSecuritySettingsRequest. 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.SecuritySettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetSecuritySettings() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::GetSecuritySettings	(	std::string const &	name,
		Options	opts = {}
	)

Retrieves the specified SecuritySettings.

The returned settings may be stale by up to 1 minute.

Parameters

name	Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings 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.SecuritySettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListSecuritySettings() [1/2]

StreamRange< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::ListSecuritySettings	(	google::cloud::dialogflow::cx::v3::ListSecuritySettingsRequest	request,
		Options	opts = {}
	)

Returns the list of all security settings in the specified location.

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

ListSecuritySettings() [2/2]

StreamRange< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::ListSecuritySettings	(	std::string const &	parent,
		Options	opts = {}
	)

Returns the list of all security settings in the specified location.

Parameters

parent	Required. The location to list all security settings for. Format: projects/<Project ID>/locations/<Location 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.SecuritySettings, 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]

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

default

operator=() [2/2]

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

default

UpdateSecuritySettings() [1/2]

StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::UpdateSecuritySettings	(	google::cloud::dialogflow::cx::v3::SecuritySettings const &	security_settings,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates the specified SecuritySettings.

Parameters

security_settings	Required. [SecuritySettings] object that contains values for each of the fields to update.
update_mask	Required. The mask to control which fields get updated. If the mask is not present, all fields will be 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.SecuritySettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateSecuritySettings() [2/2]

StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > google::cloud::dialogflow_cx::SecuritySettingsServiceClient::UpdateSecuritySettings	(	google::cloud::dialogflow::cx::v3::UpdateSecuritySettingsRequest const &	request,
		Options	opts = {}
	)

Updates the specified SecuritySettings.

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.UpdateSecuritySettingsRequest. 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.SecuritySettings) 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!= ( SecuritySettingsServiceClient const &  a, SecuritySettingsServiceClient const &  b  )

friend

operator==

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

friend