Package com.google.cloud.accessapproval.v1 (2.28.0)

A client to Access Approval API

The interfaces provided are listed below, along with usage samples.

AccessApprovalAdminClient

Service Description: 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 resources, named approvalRequests/{approval_request} - 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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications).

ApprovalRequests can be approved or dismissed. Google personnel 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.

Sample for AccessApprovalAdminClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
   ApprovalRequestName name =
       ApprovalRequestName.ofProjectApprovalRequestName("[PROJECT]", "[APPROVAL_REQUEST]");
   ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
 }

Classes

AccessApprovalAdminClient

Service Description: 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 resources, named approvalRequests/{approval_request} - The API has top-level settings per Project/Folder/Organization, named accessApprovalSettings

If a request is not approved or dismissed, we call it pending.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
   ApprovalRequestName name =
       ApprovalRequestName.ofProjectApprovalRequestName("[PROJECT]", "[APPROVAL_REQUEST]");
   ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
 }

Note: close() needs to be called on the AccessApprovalAdminClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AccessApprovalAdminSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessApprovalAdminSettings accessApprovalAdminSettings =
     AccessApprovalAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccessApprovalAdminClient accessApprovalAdminClient =
     AccessApprovalAdminClient.create(accessApprovalAdminSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessApprovalAdminSettings accessApprovalAdminSettings =
     AccessApprovalAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccessApprovalAdminClient accessApprovalAdminClient =
     AccessApprovalAdminClient.create(accessApprovalAdminSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessApprovalAdminSettings accessApprovalAdminSettings =
     AccessApprovalAdminSettings.newHttpJsonBuilder().build();
 AccessApprovalAdminClient accessApprovalAdminClient =
     AccessApprovalAdminClient.create(accessApprovalAdminSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

AccessApprovalAdminClient.ListApprovalRequestsFixedSizeCollection

AccessApprovalAdminClient.ListApprovalRequestsPage

AccessApprovalAdminClient.ListApprovalRequestsPagedResponse

AccessApprovalAdminSettings

Settings class to configure an instance of AccessApprovalAdminClient.

The default instance has everything set to sensible defaults:

The default service address (accessapproval.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getApprovalRequest to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AccessApprovalAdminSettings.Builder accessApprovalAdminSettingsBuilder =
     AccessApprovalAdminSettings.newBuilder();
 accessApprovalAdminSettingsBuilder
     .getApprovalRequestSettings()
     .setRetrySettings(
         accessApprovalAdminSettingsBuilder
             .getApprovalRequestSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AccessApprovalAdminSettings accessApprovalAdminSettings =
     accessApprovalAdminSettingsBuilder.build();

AccessApprovalAdminSettings.Builder

Builder for AccessApprovalAdminSettings.

AccessApprovalGrpc

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 resources, named approvalRequests/{approval_request}
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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications). ApprovalRequests can be approved or dismissed. Google personnel 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.

AccessApprovalGrpc.AccessApprovalBlockingStub

A stub to allow clients to do synchronous rpc calls to service AccessApproval.

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 resources, named approvalRequests/{approval_request}
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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications). ApprovalRequests can be approved or dismissed. Google personnel 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.

AccessApprovalGrpc.AccessApprovalFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service AccessApproval.

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 resources, named approvalRequests/{approval_request}
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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications). ApprovalRequests can be approved or dismissed. Google personnel 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.

AccessApprovalGrpc.AccessApprovalImplBase

Base class for the server implementation of the service AccessApproval.

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 resources, named approvalRequests/{approval_request}
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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications). ApprovalRequests can be approved or dismissed. Google personnel 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.

AccessApprovalGrpc.AccessApprovalStub

A stub to allow clients to do asynchronous rpc calls to service AccessApproval.

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 resources, named approvalRequests/{approval_request}
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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications). ApprovalRequests can be approved or dismissed. Google personnel 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.

AccessApprovalProto

AccessApprovalServiceAccount

Access Approval service account related to a project/folder/organization.

Protobuf type google.cloud.accessapproval.v1.AccessApprovalServiceAccount

AccessApprovalServiceAccount.Builder

Access Approval service account related to a project/folder/organization.

Protobuf type google.cloud.accessapproval.v1.AccessApprovalServiceAccount

AccessApprovalSettings

Settings on a Project/Folder/Organization related to Access Approval.

Protobuf type google.cloud.accessapproval.v1.AccessApprovalSettings

AccessApprovalSettings.Builder

Settings on a Project/Folder/Organization related to Access Approval.

Protobuf type google.cloud.accessapproval.v1.AccessApprovalSettings

AccessApprovalSettingsName

AccessApprovalSettingsName.Builder

Builder for projects/{project}/accessApprovalSettings.

AccessApprovalSettingsName.FolderBuilder

Builder for folders/{folder}/accessApprovalSettings.

AccessApprovalSettingsName.OrganizationBuilder

Builder for organizations/{organization}/accessApprovalSettings.

AccessLocations

Home office and physical location of the principal.

Protobuf type google.cloud.accessapproval.v1.AccessLocations

AccessLocations.Builder

Home office and physical location of the principal.

Protobuf type google.cloud.accessapproval.v1.AccessLocations

AccessReason

Protobuf type google.cloud.accessapproval.v1.AccessReason

AccessReason.Builder

Protobuf type google.cloud.accessapproval.v1.AccessReason

ApprovalRequest

A request for the customer to approve access to a resource.

Protobuf type google.cloud.accessapproval.v1.ApprovalRequest

ApprovalRequest.Builder

A request for the customer to approve access to a resource.

Protobuf type google.cloud.accessapproval.v1.ApprovalRequest

ApprovalRequestName

ApprovalRequestName.Builder

Builder for projects/{project}/approvalRequests/{approval_request}.

ApprovalRequestName.FolderApprovalRequestBuilder

Builder for folders/{folder}/approvalRequests/{approval_request}.

ApprovalRequestName.OrganizationApprovalRequestBuilder

Builder for organizations/{organization}/approvalRequests/{approval_request}.

ApproveApprovalRequestMessage

Request to approve an ApprovalRequest.

Protobuf type google.cloud.accessapproval.v1.ApproveApprovalRequestMessage

ApproveApprovalRequestMessage.Builder

Request to approve an ApprovalRequest.

Protobuf type google.cloud.accessapproval.v1.ApproveApprovalRequestMessage

ApproveDecision

A decision that has been made to approve access to a resource.

Protobuf type google.cloud.accessapproval.v1.ApproveDecision

ApproveDecision.Builder

A decision that has been made to approve access to a resource.

Protobuf type google.cloud.accessapproval.v1.ApproveDecision

DeleteAccessApprovalSettingsMessage

Request to delete access approval settings.

Protobuf type google.cloud.accessapproval.v1.DeleteAccessApprovalSettingsMessage

DeleteAccessApprovalSettingsMessage.Builder

Request to delete access approval settings.

Protobuf type google.cloud.accessapproval.v1.DeleteAccessApprovalSettingsMessage

DismissApprovalRequestMessage

Request to dismiss an approval request.

Protobuf type google.cloud.accessapproval.v1.DismissApprovalRequestMessage

DismissApprovalRequestMessage.Builder

Request to dismiss an approval request.

Protobuf type google.cloud.accessapproval.v1.DismissApprovalRequestMessage

DismissDecision

A decision that has been made to dismiss an approval request.

Protobuf type google.cloud.accessapproval.v1.DismissDecision

DismissDecision.Builder

A decision that has been made to dismiss an approval request.

Protobuf type google.cloud.accessapproval.v1.DismissDecision

EnrolledService

Represents the enrollment of a cloud resource into a specific service.

Protobuf type google.cloud.accessapproval.v1.EnrolledService

EnrolledService.Builder

Represents the enrollment of a cloud resource into a specific service.

Protobuf type google.cloud.accessapproval.v1.EnrolledService

FolderName

FolderName.Builder

Builder for folders/{folder}.

GetAccessApprovalServiceAccountMessage

Request to get an Access Approval service account.

Protobuf type google.cloud.accessapproval.v1.GetAccessApprovalServiceAccountMessage

GetAccessApprovalServiceAccountMessage.Builder

Request to get an Access Approval service account.

Protobuf type google.cloud.accessapproval.v1.GetAccessApprovalServiceAccountMessage

GetAccessApprovalSettingsMessage

Request to get access approval settings.

Protobuf type google.cloud.accessapproval.v1.GetAccessApprovalSettingsMessage

GetAccessApprovalSettingsMessage.Builder

Request to get access approval settings.

Protobuf type google.cloud.accessapproval.v1.GetAccessApprovalSettingsMessage

GetApprovalRequestMessage

Request to get an approval request.

Protobuf type google.cloud.accessapproval.v1.GetApprovalRequestMessage

GetApprovalRequestMessage.Builder

Request to get an approval request.

Protobuf type google.cloud.accessapproval.v1.GetApprovalRequestMessage

InvalidateApprovalRequestMessage

Request to invalidate an existing approval.

Protobuf type google.cloud.accessapproval.v1.InvalidateApprovalRequestMessage

InvalidateApprovalRequestMessage.Builder

Request to invalidate an existing approval.

Protobuf type google.cloud.accessapproval.v1.InvalidateApprovalRequestMessage

ListApprovalRequestsMessage

Request to list approval requests.

Protobuf type google.cloud.accessapproval.v1.ListApprovalRequestsMessage

ListApprovalRequestsMessage.Builder

Request to list approval requests.

Protobuf type google.cloud.accessapproval.v1.ListApprovalRequestsMessage

ListApprovalRequestsResponse

Response to listing of ApprovalRequest objects.

Protobuf type google.cloud.accessapproval.v1.ListApprovalRequestsResponse

ListApprovalRequestsResponse.Builder

Response to listing of ApprovalRequest objects.

Protobuf type google.cloud.accessapproval.v1.ListApprovalRequestsResponse

OrganizationName

OrganizationName.Builder

Builder for organizations/{organization}.

ProjectName

ProjectName.Builder

Builder for projects/{project}.

ResourceProperties

The properties associated with the resource of the request.

Protobuf type google.cloud.accessapproval.v1.ResourceProperties

ResourceProperties.Builder

The properties associated with the resource of the request.

Protobuf type google.cloud.accessapproval.v1.ResourceProperties

SignatureInfo

Information about the digital signature of the resource.

Protobuf type google.cloud.accessapproval.v1.SignatureInfo

SignatureInfo.Builder

Information about the digital signature of the resource.

Protobuf type google.cloud.accessapproval.v1.SignatureInfo

UpdateAccessApprovalSettingsMessage

Request to update access approval settings.

Protobuf type google.cloud.accessapproval.v1.UpdateAccessApprovalSettingsMessage

UpdateAccessApprovalSettingsMessage.Builder

Request to update access approval settings.

Protobuf type google.cloud.accessapproval.v1.UpdateAccessApprovalSettingsMessage

Interfaces

AccessApprovalGrpc.AsyncService

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 resources, named approvalRequests/{approval_request}
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 Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications). ApprovalRequests can be approved or dismissed. Google personnel 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.

Package com.google.cloud.accessapproval.v1 (2.28.0)

AccessApprovalAdminClient

Classes

Interfaces

Enums