Access Approval v1 API - Class AccessApproval.AccessApprovalBase (2.4.0)

Version 2.4.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(AccessApproval), "BindService")]
public abstract class AccessApproval.AccessApprovalBase

Reference documentation and code samples for the Access Approval v1 API class AccessApproval.AccessApprovalBase.

Base class for server-side implementations of AccessApproval

Inheritance

object > AccessApproval.AccessApprovalBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AccessApproval.V1

Assembly

Google.Cloud.AccessApproval.V1.dll

Methods

ApproveApprovalRequest(ApproveApprovalRequestMessage, ServerCallContext)

public virtual Task<ApprovalRequest> ApproveApprovalRequest(ApproveApprovalRequestMessage request, ServerCallContext context)

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
Name	Description
request	ApproveApprovalRequestMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskApprovalRequest	The response to send back to the client (wrapped by a task).

DeleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage, ServerCallContext)

public virtual Task<Empty> DeleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessage request, ServerCallContext context)

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
Name	Description
request	DeleteAccessApprovalSettingsMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DismissApprovalRequest(DismissApprovalRequestMessage, ServerCallContext)

public virtual Task<ApprovalRequest> DismissApprovalRequest(DismissApprovalRequestMessage request, ServerCallContext context)

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
Name	Description
request	DismissApprovalRequestMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskApprovalRequest	The response to send back to the client (wrapped by a task).

GetAccessApprovalServiceAccount(GetAccessApprovalServiceAccountMessage, ServerCallContext)

public virtual Task<AccessApprovalServiceAccount> GetAccessApprovalServiceAccount(GetAccessApprovalServiceAccountMessage request, ServerCallContext context)

Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

Parameters
Name	Description
request	GetAccessApprovalServiceAccountMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAccessApprovalServiceAccount	The response to send back to the client (wrapped by a task).

GetAccessApprovalSettings(GetAccessApprovalSettingsMessage, ServerCallContext)

public virtual Task<AccessApprovalSettings> GetAccessApprovalSettings(GetAccessApprovalSettingsMessage request, ServerCallContext context)

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

Parameters
Name	Description
request	GetAccessApprovalSettingsMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAccessApprovalSettings	The response to send back to the client (wrapped by a task).

GetApprovalRequest(GetApprovalRequestMessage, ServerCallContext)

public virtual Task<ApprovalRequest> GetApprovalRequest(GetApprovalRequestMessage request, ServerCallContext context)

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

Parameters
Name	Description
request	GetApprovalRequestMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskApprovalRequest	The response to send back to the client (wrapped by a task).

InvalidateApprovalRequest(InvalidateApprovalRequestMessage, ServerCallContext)

public virtual Task<ApprovalRequest> InvalidateApprovalRequest(InvalidateApprovalRequestMessage request, ServerCallContext context)

Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest.

NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval.

Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

Parameters
Name	Description
request	InvalidateApprovalRequestMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskApprovalRequest	The response to send back to the client (wrapped by a task).

ListApprovalRequests(ListApprovalRequestsMessage, ServerCallContext)

public virtual Task<ListApprovalRequestsResponse> ListApprovalRequests(ListApprovalRequestsMessage request, ServerCallContext context)

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
Name	Description
request	ListApprovalRequestsMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListApprovalRequestsResponse	The response to send back to the client (wrapped by a task).

UpdateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage, ServerCallContext)

public virtual Task<AccessApprovalSettings> UpdateAccessApprovalSettings(UpdateAccessApprovalSettingsMessage request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateAccessApprovalSettingsMessage The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAccessApprovalSettings	The response to send back to the client (wrapped by a task).