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.
Constructors
SecuritySettingsServiceClient(SecuritySettingsServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecuritySettingsServiceClient const &
|
SecuritySettingsServiceClient(SecuritySettingsServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecuritySettingsServiceClient &&
|
SecuritySettingsServiceClient(std::shared_ptr< SecuritySettingsServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SecuritySettingsServiceConnection >
|
opts |
Options
|
Operators
operator=(SecuritySettingsServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecuritySettingsServiceClient const &
|
Returns | |
---|---|
Type | Description |
SecuritySettingsServiceClient & |
operator=(SecuritySettingsServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecuritySettingsServiceClient &&
|
Returns | |
---|---|
Type | Description |
SecuritySettingsServiceClient & |
Functions
CreateSecuritySettings(std::string const &, google::cloud::dialogflow::cx::v3::SecuritySettings const &, Options)
Create security settings in the specified location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The location to create an SecuritySettings for. Format: |
security_settings |
google::cloud::dialogflow::cx::v3::SecuritySettings const &
Required. The security settings to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > |
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 |
CreateSecuritySettings(google::cloud::dialogflow::cx::v3::CreateSecuritySettingsRequest const &, Options)
Create security settings in the specified location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::CreateSecuritySettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > |
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 |
GetSecuritySettings(std::string const &, Options)
Retrieves the specified SecuritySettings.
The returned settings may be stale by up to 1 minute.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Resource name of the settings. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > |
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 |
GetSecuritySettings(google::cloud::dialogflow::cx::v3::GetSecuritySettingsRequest const &, Options)
Retrieves the specified SecuritySettings.
The returned settings may be stale by up to 1 minute.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::GetSecuritySettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > |
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 |
UpdateSecuritySettings(google::cloud::dialogflow::cx::v3::SecuritySettings const &, google::protobuf::FieldMask const &, Options)
Updates the specified SecuritySettings.
Parameters | |
---|---|
Name | Description |
security_settings |
google::cloud::dialogflow::cx::v3::SecuritySettings const &
Required. [SecuritySettings] object that contains values for each of the fields to update. |
update_mask |
google::protobuf::FieldMask const &
Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > |
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 |
UpdateSecuritySettings(google::cloud::dialogflow::cx::v3::UpdateSecuritySettingsRequest const &, Options)
Updates the specified SecuritySettings.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::UpdateSecuritySettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::SecuritySettings > |
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 |
ListSecuritySettings(std::string const &, Options)
Returns the list of all security settings in the specified location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The location to list all security settings for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::cx::v3::SecuritySettings > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSecuritySettings(google::cloud::dialogflow::cx::v3::ListSecuritySettingsRequest, Options)
Returns the list of all security settings in the specified location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::ListSecuritySettingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::cx::v3::SecuritySettings > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteSecuritySettings(std::string const &, Options)
Deletes the specified SecuritySettings.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the SecuritySettings to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteSecuritySettings(google::cloud::dialogflow::cx::v3::DeleteSecuritySettingsRequest const &, Options)
Deletes the specified SecuritySettings.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::DeleteSecuritySettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |