Class SecuritySettingsServiceClient (0.4.1)

SecuritySettingsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport]] = None, 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

Return the transport used by the client instance.

Returns
TypeDescription
SecuritySettingsServiceTransportThe transport used by the client instance.

Methods

SecuritySettingsServiceClient

SecuritySettingsServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.security_settings_service.transports.base.SecuritySettingsServiceTransport]] = None, 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>)

Instantiate the security settings service client.

Parameters
NameDescription
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 google.api_core.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.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_security_settings

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

Create security settings in the specified location.

Parameters
NameDescription
request google.cloud.dialogflowcx_v3.types.CreateSecuritySettingsRequest

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 google.cloud.dialogflowcx_v3.types.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
TypeDescription
google.cloud.dialogflowcx_v3.types.SecuritySettingsRepresents 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_v3.types.security_settings.DeleteSecuritySettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified xref_SecuritySettings.

Parameters
NameDescription
request google.cloud.dialogflowcx_v3.types.DeleteSecuritySettingsRequest

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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
SecuritySettingsServiceClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
SecuritySettingsServiceClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
SecuritySettingsServiceClientThe constructed client.

get_security_settings

get_security_settings(request: Optional[google.cloud.dialogflowcx_v3.types.security_settings.GetSecuritySettingsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
NameDescription
request google.cloud.dialogflowcx_v3.types.GetSecuritySettingsRequest

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
TypeDescription
google.cloud.dialogflowcx_v3.types.SecuritySettingsRepresents 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.

list_security_settings

list_security_settings(request: Optional[google.cloud.dialogflowcx_v3.types.security_settings.ListSecuritySettingsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
NameDescription
request google.cloud.dialogflowcx_v3.types.ListSecuritySettingsRequest

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
TypeDescription
google.cloud.dialogflowcx_v3.services.security_settings_service.pagers.ListSecuritySettingsPagerThe 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_security_settings_path

parse_security_settings_path(path: str)

Parse a security_settings path into its component segments.

security_settings_path

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

Return a fully-qualified security_settings string.

update_security_settings

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

Updates the specified xref_SecuritySettings.

Parameters
NameDescription
request google.cloud.dialogflowcx_v3.types.UpdateSecuritySettingsRequest

The request object. The request message for SecuritySettingsService.UpdateSecuritySettings.

security_settings google.cloud.dialogflowcx_v3.types.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
TypeDescription
google.cloud.dialogflowcx_v3.types.SecuritySettingsRepresents 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.