com.google.cloud.accessapproval.v1

Class AccessApprovalGrpc.AccessApprovalBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<AccessApprovalGrpc.AccessApprovalBlockingStub>

com.google.cloud.accessapproval.v1.AccessApprovalGrpc.AccessApprovalBlockingStub

Enclosing class:

AccessApprovalGrpc

public static final class AccessApprovalGrpc.AccessApprovalBlockingStub
extends io.grpc.stub.AbstractBlockingStub<AccessApprovalGrpc.AccessApprovalBlockingStub>

 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}`
 - 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
ApprovalRequest	approveApprovalRequest(ApproveApprovalRequestMessage request) Approves a request and returns the updated ApprovalRequest.
protected AccessApprovalGrpc.AccessApprovalBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.protobuf.Empty	deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage request) Deletes the settings associated with a project, folder, or organization.
ApprovalRequest	dismissApprovalRequest(DismissApprovalRequestMessage request) Dismisses a request.
AccessApprovalSettings	getAccessApprovalSettings(GetAccessApprovalSettingsMessage request) Gets the settings associated with a project, folder, or organization.
ApprovalRequest	getApprovalRequest(GetApprovalRequestMessage request) Gets an approval request.
ListApprovalRequestsResponse	listApprovalRequests(ListApprovalRequestsMessage request) Lists approval requests associated with a project, folder, or organization.
AccessApprovalSettings	updateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage request) Updates the settings associated with a project, folder, or organization.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected AccessApprovalGrpc.AccessApprovalBlockingStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<AccessApprovalGrpc.AccessApprovalBlockingStub>

listApprovalRequests

public ListApprovalRequestsResponse listApprovalRequests(ListApprovalRequestsMessage request)

 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.
 

getApprovalRequest

public ApprovalRequest getApprovalRequest(GetApprovalRequestMessage request)

 Gets an approval request. Returns NOT_FOUND if the request does not exist.
 

approveApprovalRequest

public ApprovalRequest approveApprovalRequest(ApproveApprovalRequestMessage request)

 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.
 

dismissApprovalRequest

public ApprovalRequest dismissApprovalRequest(DismissApprovalRequestMessage request)

 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.
 

getAccessApprovalSettings

public AccessApprovalSettings getAccessApprovalSettings(GetAccessApprovalSettingsMessage request)

 Gets the settings associated with a project, folder, or organization.
 

updateAccessApprovalSettings

public AccessApprovalSettings updateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage request)

 Updates the settings associated with a project, folder, or organization.
 Settings to update are determined by the value of field_mask.
 

deleteAccessApprovalSettings

public com.google.protobuf.Empty deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage request)

 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.