def update_access_approval_settings(
self,
request: Union[accessapproval.UpdateAccessApprovalSettingsMessage,
dict] = None,
*,
settings: accessapproval.AccessApprovalSettings = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> accessapproval.AccessApprovalSettings:
r"""Updates the settings associated with a project, folder, or
organization. Settings to update are determined by the value of
field_mask.
.. code-block:: python
from google.cloud import accessapproval_v1
def sample_update_access_approval_settings():
# Create a client
client = accessapproval_v1.AccessApprovalClient()
# Initialize request argument(s)
request = accessapproval_v1.UpdateAccessApprovalSettingsMessage(
)
# Make the request
response = client.update_access_approval_settings(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.accessapproval_v1.types.UpdateAccessApprovalSettingsMessage, dict]):
The request object. Request to update access approval
settings.
settings (google.cloud.accessapproval_v1.types.AccessApprovalSettings):
The new AccessApprovalSettings.
This corresponds to the ``settings`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
The update mask applies to the settings. Only the top
level fields of AccessApprovalSettings
(notification_emails & enrolled_services) are supported.
For each field, if it is included, the currently stored
value will be entirely overwritten with the value of the
field passed in this request.
For the ``FieldMask`` definition, see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
If this field is left unset, only the
notification_emails field 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.accessapproval_v1.types.AccessApprovalSettings:
Settings on a
Project/Folder/Organization related to
Access Approval.
"""
# 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([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 accessapproval.UpdateAccessApprovalSettingsMessage.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request,
accessapproval.UpdateAccessApprovalSettingsMessage):
request = accessapproval.UpdateAccessApprovalSettingsMessage(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if settings is not None:
request.settings = 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_access_approval_settings]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("settings.name", request.settings.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def update_access_approval_settings(
self,
request: accessapproval.UpdateAccessApprovalSettingsMessage = None,
*,
settings: accessapproval.AccessApprovalSettings = None,
update_mask: field_mask.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> accessapproval.AccessApprovalSettings:
r"""Updates the settings associated with a project, folder, or
organization. Settings to update are determined by the value of
field_mask.
Args:
request (:class:`~.accessapproval.UpdateAccessApprovalSettingsMessage`):
The request object. Request to update access approval
settings.
settings (:class:`~.accessapproval.AccessApprovalSettings`):
The new AccessApprovalSettings.
This corresponds to the ``settings`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`~.field_mask.FieldMask`):
The update mask applies to the settings. Only the top
level fields of AccessApprovalSettings
(notification_emails & enrolled_services) are supported.
For each field, if it is included, the currently stored
value will be entirely overwritten with the value of the
field passed in this request.
For the ``FieldMask`` definition, see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
If this field is left unset, only the
notification_emails field 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:
~.accessapproval.AccessApprovalSettings:
Settings on a
Project/Folder/Organization related to
Access Approval.
"""
# 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.
if request is not None and any([settings, update_mask]):
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = accessapproval.UpdateAccessApprovalSettingsMessage(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if settings is not None:
request.settings = 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_access_approval_settings,
default_timeout=600.0,
client_info=_client_info,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("settings.name", request.settings.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
