async def update_security_settings(
self,
request: Union[gcdc_security_settings.UpdateSecuritySettingsRequest,
dict] = None,
*,
security_settings: gcdc_security_settings.SecuritySettings = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_security_settings.SecuritySettings:
r"""Updates the specified
[SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
.. code-block::
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)
Args:
request (Union[google.cloud.dialogflowcx_v3.types.UpdateSecuritySettingsRequest, dict]):
The request object. The request message for
[SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].
security_settings (:class:`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 (:class:`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:
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.
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([security_settings, update_mask])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = gcdc_security_settings.UpdateSecuritySettingsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if security_settings is not None:
request.security_settings = security_settings
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.update_security_settings,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("security_settings.name", request.security_settings.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def update_security_settings(
self,
request: gcdc_security_settings.UpdateSecuritySettingsRequest = None,
*,
security_settings: gcdc_security_settings.SecuritySettings = None,
update_mask: field_mask.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcdc_security_settings.SecuritySettings:
r"""Updates the specified
[SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
Args:
request (google.cloud.dialogflowcx_v3.types.UpdateSecuritySettingsRequest):
The request object. The request message for
[SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.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:
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.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([security_settings, update_mask])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a gcdc_security_settings.UpdateSecuritySettingsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(
request, gcdc_security_settings.UpdateSecuritySettingsRequest):
request = gcdc_security_settings.UpdateSecuritySettingsRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if security_settings is not None:
request.security_settings = security_settings
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.update_security_settings]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("security_settings.name", request.security_settings.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response