Class SecuritySettingsServiceAsyncClient (1.9.1)

Version 1.9.1

• 1.38.0 (latest)
• 1.37.0
• 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: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = 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.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
SecuritySettingsServiceTransport	The transport used by the client instance.

Methods

SecuritySettingsServiceAsyncClient

SecuritySettingsServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the security settings service client.

Parameters
Name	Description
credentials	Optional[google.auth.credentials.Credentials] The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, .SecuritySettingsServiceTransport] The transport to use. If set to None, a transport is chosen automatically.
client_options	ClientOptions Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_security_settings

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

Create security settings in the specified location.

from google.cloud import dialogflowcx_v3

def sample_create_security_settings():
    # Create a client
    client = dialogflowcx_v3.SecuritySettingsServiceClient()

    # Initialize request argument(s)
    security_settings = dialogflowcx_v3.SecuritySettings()
    security_settings.retention_window_days = 2271
    security_settings.display_name = "display_name_value"

    request = dialogflowcx_v3.CreateSecuritySettingsRequest(
        parent="parent_value",
        security_settings=security_settings,
    )

    # Make the request
    response = client.create_security_settings(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3.types.CreateSecuritySettingsRequest, dict] The request object. The request message for [SecuritySettings.CreateSecuritySettings][].
parent	str Required. The location to create an SecuritySettings for. Format: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
security_settings	SecuritySettings Required. The security settings to create. This corresponds to the security_settings field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3.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.

deidentify_template_path

deidentify_template_path(
    organization: str, location: str, deidentify_template: str
)

Returns a fully-qualified deidentify_template string.

delete_security_settings

delete_security_settings(request: Optional[Union[google.cloud.dialogflowcx_v3.types.security_settings.DeleteSecuritySettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified xref_SecuritySettings.

from google.cloud import dialogflowcx_v3

def sample_delete_security_settings():
    # Create a client
    client = dialogflowcx_v3.SecuritySettingsServiceClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.DeleteSecuritySettingsRequest(
        name="name_value",
    )

    # Make the request
    client.delete_security_settings(request=request)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3.types.DeleteSecuritySettingsRequest, dict] The request object. The request message for [SecuritySettings.DeleteSecuritySettings][].
name	str Required. The name of the SecuritySettings to delete. Format: projects/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

from_service_account_file

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

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

Parameter
Name	Description
filename	str The path to the service account private key json file.

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.

Parameter
Name	Description
info	dict The service account private key info.

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.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
SecuritySettingsServiceAsyncClient	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
client_options	google.api_core.client_options.ClientOptions Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_security_settings

get_security_settings(request: Optional[Union[google.cloud.dialogflowcx_v3.types.security_settings.GetSecuritySettingsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the specified xref_SecuritySettings. The returned settings may be stale by up to 1 minute.

from google.cloud import dialogflowcx_v3

def sample_get_security_settings():
    # Create a client
    client = dialogflowcx_v3.SecuritySettingsServiceClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.GetSecuritySettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_security_settings(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3.types.GetSecuritySettingsRequest, dict] The request object. The request message for SecuritySettingsService.GetSecuritySettings.
name	str Required. Resource name of the settings. Format: projects/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3.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()

Returns an appropriate transport class.

inspect_template_path

inspect_template_path(organization: str, location: str, inspect_template: str)

Returns a fully-qualified inspect_template string.

list_security_settings

list_security_settings(request: Optional[Union[google.cloud.dialogflowcx_v3.types.security_settings.ListSecuritySettingsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import dialogflowcx_v3

def sample_list_security_settings():
    # Create a client
    client = dialogflowcx_v3.SecuritySettingsServiceClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3.ListSecuritySettingsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_security_settings(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3.types.ListSecuritySettingsRequest, dict] The request object. The request message for [SecuritySettings.ListSecuritySettings][].
parent	str Required. The location to list all security settings for. Format: projects/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3.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.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_deidentify_template_path

parse_deidentify_template_path(path: str)

Parses a deidentify_template path into its component segments.

parse_inspect_template_path

parse_inspect_template_path(path: str)

Parses a inspect_template path into its component segments.

parse_security_settings_path

parse_security_settings_path(path: str)

Parses a security_settings path into its component segments.

security_settings_path

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

Returns a fully-qualified security_settings string.

update_security_settings

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

Updates the specified xref_SecuritySettings.

from google.cloud import dialogflowcx_v3

def sample_update_security_settings():
    # Create a client
    client = dialogflowcx_v3.SecuritySettingsServiceClient()

    # Initialize request argument(s)
    security_settings = dialogflowcx_v3.SecuritySettings()
    security_settings.retention_window_days = 2271
    security_settings.display_name = "display_name_value"

    request = dialogflowcx_v3.UpdateSecuritySettingsRequest(
        security_settings=security_settings,
    )

    # Make the request
    response = client.update_security_settings(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.dialogflowcx_v3.types.UpdateSecuritySettingsRequest, dict] The request object. The request message for SecuritySettingsService.UpdateSecuritySettings.
security_settings	SecuritySettings Required. [SecuritySettings] object that contains values for each of the fields to update. This corresponds to the security_settings field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.dialogflowcx_v3.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.