AccessApproval¶
- class google.cloud.accessapproval_v1.services.access_approval.AccessApprovalAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/usr/lib/python3.10/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>)[source]¶
This API allows a customer to manage accesses to cloud resources by Google personnel. It defines the following resource model:
The API has a collection of [ApprovalRequest][google.cloud.accessapproval.v1.ApprovalRequest] resources, named
approvalRequests/{approval_request_id}
The API has top-level settings per Project/Folder/Organization, named
accessApprovalSettings
The service also periodically emails a list of recipients, defined at the Project/Folder/Organization level in the accessApprovalSettings, when there is a pending ApprovalRequest for them to act on. The ApprovalRequests can also optionally be published to a Cloud Pub/Sub topic owned by the customer (for Beta, the Pub/Sub setup is managed manually).
ApprovalRequests can be approved or dismissed. Google personel can only access the indicated resource or resources if the request is approved (subject to some exclusions: https://cloud.google.com/access-approval/docs/overview#exclusions).
Note: Using Access Approval functionality will mean that Google may not be able to meet the SLAs for your chosen products, as any support response times may be dramatically increased. As such the SLAs do not apply to any service disruption to the extent impacted by Customer’s use of Access Approval. Do not enable Access Approval for projects where you may require high service availability and rapid response by Google Cloud Support.
After a request is approved or dismissed, no further action may be taken on it. Requests with the requested_expiration in the past or with no activity for 14 days are considered dismissed. When an approval expires, the request is considered dismissed.
If a request is not approved or dismissed, we call it pending.
Instantiates the access approval client.
- Parameters
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, AccessApprovalTransport]) – 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) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- async approve_approval_request(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.ApproveApprovalRequestMessage] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.ApprovalRequest [source]¶
Approves a request and returns the updated ApprovalRequest.
Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
- Parameters
request (
google.cloud.accessapproval_v1.types.ApproveApprovalRequestMessage
) – The request object. Request to approve an ApprovalRequest.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
A request for the customer to approve access to a resource.
- Return type
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_folder_path(folder: str) str ¶
Returns a fully-qualified folder string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static common_project_path(project: str) str ¶
Returns a fully-qualified project string.
- async delete_access_approval_settings(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.DeleteAccessApprovalSettingsMessage] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
- Parameters
request (
google.cloud.accessapproval_v1.types.DeleteAccessApprovalSettingsMessage
) – The request object. Request to delete access approval settings.name (
str
) –Name of the AccessApprovalSettings to delete.
This corresponds to the
name
field on therequest
instance; ifrequest
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.
- async dismiss_approval_request(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.DismissApprovalRequestMessage] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.ApprovalRequest [source]¶
Dismisses a request. Returns the updated ApprovalRequest.
NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether.
Returns NOT_FOUND if the request does not exist.
Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
- Parameters
request (
google.cloud.accessapproval_v1.types.DismissApprovalRequestMessage
) – The request object. Request to dismiss an approval request.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
A request for the customer to approve access to a resource.
- Return type
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
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
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
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
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
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
The constructed client.
- Return type
- async get_access_approval_settings(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.GetAccessApprovalSettingsMessage] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings [source]¶
Gets the settings associated with a project, folder, or organization.
- Parameters
request (
google.cloud.accessapproval_v1.types.GetAccessApprovalSettingsMessage
) – The request object. Request to get access approval settings.name (
str
) –Name of the AccessApprovalSettings to retrieve.
This corresponds to the
name
field on therequest
instance; ifrequest
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
Settings on a Project/Folder/Organization related to Access Approval.
- Return type
- async get_approval_request(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.GetApprovalRequestMessage] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.ApprovalRequest [source]¶
Gets an approval request. Returns NOT_FOUND if the request does not exist.
- Parameters
request (
google.cloud.accessapproval_v1.types.GetApprovalRequestMessage
) – The request object. Request to get an approval request.name (
str
) –Name of the approval request to retrieve.
This corresponds to the
name
field on therequest
instance; ifrequest
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
A request for the customer to approve access to a resource.
- Return type
- get_transport_class() Type[google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async list_approval_requests(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsMessage] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsAsyncPager [source]¶
Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
- Parameters
request (
google.cloud.accessapproval_v1.types.ListApprovalRequestsMessage
) – The request object. Request to list approval requests.parent (
str
) –The parent resource. This may be “projects/{project_id}”, “folders/{folder_id}”, or “organizations/{organization_id}”.
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response to listing of ApprovalRequest objects. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsAsyncPager
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- property transport: google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
AccessApprovalTransport
- async update_access_approval_settings(request: Optional[google.cloud.accessapproval_v1.types.accessapproval.UpdateAccessApprovalSettingsMessage] = None, *, settings: Optional[google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings] = 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]] = ()) google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings [source]¶
Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
- Parameters
request (
google.cloud.accessapproval_v1.types.UpdateAccessApprovalSettingsMessage
) – The request object. Request to update access approval settings.settings (
google.cloud.accessapproval_v1.types.AccessApprovalSettings
) – The new AccessApprovalSettings. This corresponds to thesettings
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
Settings on a Project/Folder/Organization related to Access Approval.
- Return type
- class google.cloud.accessapproval_v1.services.access_approval.AccessApprovalClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport]] = 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>)[source]¶
This API allows a customer to manage accesses to cloud resources by Google personnel. It defines the following resource model:
The API has a collection of [ApprovalRequest][google.cloud.accessapproval.v1.ApprovalRequest] resources, named
approvalRequests/{approval_request_id}
The API has top-level settings per Project/Folder/Organization, named
accessApprovalSettings
The service also periodically emails a list of recipients, defined at the Project/Folder/Organization level in the accessApprovalSettings, when there is a pending ApprovalRequest for them to act on. The ApprovalRequests can also optionally be published to a Cloud Pub/Sub topic owned by the customer (for Beta, the Pub/Sub setup is managed manually).
ApprovalRequests can be approved or dismissed. Google personel can only access the indicated resource or resources if the request is approved (subject to some exclusions: https://cloud.google.com/access-approval/docs/overview#exclusions).
Note: Using Access Approval functionality will mean that Google may not be able to meet the SLAs for your chosen products, as any support response times may be dramatically increased. As such the SLAs do not apply to any service disruption to the extent impacted by Customer’s use of Access Approval. Do not enable Access Approval for projects where you may require high service availability and rapid response by Google Cloud Support.
After a request is approved or dismissed, no further action may be taken on it. Requests with the requested_expiration in the past or with no activity for 14 days are considered dismissed. When an approval expires, the request is considered dismissed.
If a request is not approved or dismissed, we call it pending.
Instantiates the access approval client.
- Parameters
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, AccessApprovalTransport]) – 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) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- approve_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.ApproveApprovalRequestMessage, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.ApprovalRequest [source]¶
Approves a request and returns the updated ApprovalRequest.
Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
- Parameters
request (Union[google.cloud.accessapproval_v1.types.ApproveApprovalRequestMessage, dict]) – The request object. Request to approve an ApprovalRequest.
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
A request for the customer to approve access to a resource.
- Return type
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- delete_access_approval_settings(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.DeleteAccessApprovalSettingsMessage, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
- Parameters
request (Union[google.cloud.accessapproval_v1.types.DeleteAccessApprovalSettingsMessage, dict]) – The request object. Request to delete access approval settings.
name (str) –
Name of the AccessApprovalSettings to delete.
This corresponds to the
name
field on therequest
instance; ifrequest
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.
- dismiss_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.DismissApprovalRequestMessage, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.ApprovalRequest [source]¶
Dismisses a request. Returns the updated ApprovalRequest.
NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether.
Returns NOT_FOUND if the request does not exist.
Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
- Parameters
request (Union[google.cloud.accessapproval_v1.types.DismissApprovalRequestMessage, dict]) – The request object. Request to dismiss an approval request.
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
A request for the customer to approve access to a resource.
- Return type
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
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
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
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
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
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
The constructed client.
- Return type
- get_access_approval_settings(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.GetAccessApprovalSettingsMessage, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings [source]¶
Gets the settings associated with a project, folder, or organization.
- Parameters
request (Union[google.cloud.accessapproval_v1.types.GetAccessApprovalSettingsMessage, dict]) – The request object. Request to get access approval settings.
name (str) –
Name of the AccessApprovalSettings to retrieve.
This corresponds to the
name
field on therequest
instance; ifrequest
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
Settings on a Project/Folder/Organization related to Access Approval.
- Return type
- get_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.GetApprovalRequestMessage, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.types.accessapproval.ApprovalRequest [source]¶
Gets an approval request. Returns NOT_FOUND if the request does not exist.
- Parameters
request (Union[google.cloud.accessapproval_v1.types.GetApprovalRequestMessage, dict]) – The request object. Request to get an approval request.
name (str) –
Name of the approval request to retrieve.
This corresponds to the
name
field on therequest
instance; ifrequest
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
A request for the customer to approve access to a resource.
- Return type
- list_approval_requests(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsMessage, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsPager [source]¶
Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
- Parameters
request (Union[google.cloud.accessapproval_v1.types.ListApprovalRequestsMessage, dict]) – The request object. Request to list approval requests.
parent (str) –
The parent resource. This may be “projects/{project_id}”, “folders/{folder_id}”, or “organizations/{organization_id}”.
This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response to listing of ApprovalRequest objects. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsPager
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- property transport: google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
AccessApprovalTransport
- update_access_approval_settings(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.UpdateAccessApprovalSettingsMessage, dict]] = None, *, settings: Optional[google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings] = 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]] = ()) google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings [source]¶
Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.
- Parameters
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
Settings on a Project/Folder/Organization related to Access Approval.
- Return type
- class google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsAsyncPager(method: Callable[[...], Awaitable[google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsResponse]], request: google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsMessage, response: google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_approval_requests
requests.This class thinly wraps an initial
google.cloud.accessapproval_v1.types.ListApprovalRequestsResponse
object, and provides an__aiter__
method to iterate through itsapproval_requests
field.If there are more pages, the
__aiter__
method will make additionalListApprovalRequests
requests and continue to iterate through theapproval_requests
field on the corresponding responses.All the usual
google.cloud.accessapproval_v1.types.ListApprovalRequestsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.accessapproval_v1.types.ListApprovalRequestsMessage) – The initial request object.
response (google.cloud.accessapproval_v1.types.ListApprovalRequestsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsPager(method: Callable[[...], google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsResponse], request: google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsMessage, response: google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_approval_requests
requests.This class thinly wraps an initial
google.cloud.accessapproval_v1.types.ListApprovalRequestsResponse
object, and provides an__iter__
method to iterate through itsapproval_requests
field.If there are more pages, the
__iter__
method will make additionalListApprovalRequests
requests and continue to iterate through theapproval_requests
field on the corresponding responses.All the usual
google.cloud.accessapproval_v1.types.ListApprovalRequestsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.accessapproval_v1.types.ListApprovalRequestsMessage) – The initial request object.
response (google.cloud.accessapproval_v1.types.ListApprovalRequestsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.