Class SecuritySettingsServiceAsyncClient (0.8.0)

Version 0.8.0

• 1.37.0 (latest)
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.5
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.0
• 0.8.2
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.1

SecuritySettingsServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3beta1.services.security_settings_service.transports.base.SecuritySettingsServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing security settings for Dialogflow.

Inheritance

builtins.object > SecuritySettingsServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
SecuritySettingsServiceTransport	The transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter

Name	Description
billing_account

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter

Name	Description
folder

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters

Name	Description
project
location

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter

Name	Description
organization

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter

Name	Description
project

create_security_settings

create_security_settings(request: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.CreateSecuritySettingsRequest] = None, *, parent: Optional[str] = None, security_settings: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.SecuritySettings] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create security settings in the specified location.

Parameter

Name	Description
request	The request object. The request message for [SecuritySettings.CreateSecuritySettings][].

Returns

Type	Description
	Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

delete_security_settings

delete_security_settings(request: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.DeleteSecuritySettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings].

Parameter

Name	Description
request	The request object. The request message for [SecuritySettings.DeleteSecuritySettings][].

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

Name	Description
filename	str The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
SecuritySettingsServiceAsyncClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters

Name	Description
info	dict The service account private key info.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
SecuritySettingsServiceAsyncClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters

Name	Description
filename	str The path to the service account private key json file.
args	Additional arguments to pass to the constructor.
kwargs	Additional arguments to pass to the constructor.

Returns

Type	Description
SecuritySettingsServiceAsyncClient	The constructed client.

get_security_settings

get_security_settings(request: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.GetSecuritySettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings]. The returned settings may be stale by up to 1 minute.

Parameter

Name	Description
request	The request object. The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.GetSecuritySettings].

Returns

Type	Description
google.cloud.dialogflowcx_v3beta1.types.SecuritySettings	Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter

Name	Description
label

list_security_settings

list_security_settings(request: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.ListSecuritySettingsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameter

Name	Description
request	The request object. The request message for [SecuritySettings.ListSecuritySettings][].

Returns

Type	Description
google.cloud.dialogflowcx_v3beta1.services.security_settings_service.pagers.ListSecuritySettingsAsyncPager	The response message for [SecuritySettings.ListSecuritySettings][]. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter

Name	Description
path

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter

Name	Description
path

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter

Name	Description
path

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter

Name	Description
path

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter

Name	Description
path

parse_security_settings_path

parse_security_settings_path(path: str)

Parses a security_settings path into its component segments.

Parameter

Name	Description
path

security_settings_path

security_settings_path(project: str, location: str, security_settings: str)

Returns a fully-qualified security_settings string.

Parameters

Name	Description
project
location
security_settings

update_security_settings

update_security_settings(request: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.UpdateSecuritySettingsRequest] = None, *, security_settings: Optional[google.cloud.dialogflowcx_v3beta1.types.security_settings.SecuritySettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettings].

Parameter

Name	Description
request	The request object. The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3beta1.SecuritySettingsService.UpdateSecuritySettings].

Returns

Type	Description
	Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.