AccessApproval - Documentation

Constructor

new AccessApproval(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new AccessApproval service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

approveApprovalRequest(request, callback) → {undefined}

Calls ApproveApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IApproveApprovalRequestMessage	ApproveApprovalRequestMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.ApproveApprovalRequestCallback	Node-style callback called with the error, if any, and ApprovalRequest

Returns:

Type	Description
undefined

approveApprovalRequest(request) → {Promise.<google.cloud.accessapproval.v1.ApprovalRequest>}

Calls ApproveApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IApproveApprovalRequestMessage	ApproveApprovalRequestMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.ApprovalRequest>	Promise

deleteAccessApprovalSettings(request, callback) → {undefined}

Calls DeleteAccessApprovalSettings.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage	DeleteAccessApprovalSettingsMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.DeleteAccessApprovalSettingsCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteAccessApprovalSettings(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteAccessApprovalSettings.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IDeleteAccessApprovalSettingsMessage	DeleteAccessApprovalSettingsMessage message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

dismissApprovalRequest(request, callback) → {undefined}

Calls DismissApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IDismissApprovalRequestMessage	DismissApprovalRequestMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.DismissApprovalRequestCallback	Node-style callback called with the error, if any, and ApprovalRequest

Returns:

Type	Description
undefined

dismissApprovalRequest(request) → {Promise.<google.cloud.accessapproval.v1.ApprovalRequest>}

Calls DismissApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IDismissApprovalRequestMessage	DismissApprovalRequestMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.ApprovalRequest>	Promise

getAccessApprovalServiceAccount(request, callback) → {undefined}

Calls GetAccessApprovalServiceAccount.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage	GetAccessApprovalServiceAccountMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalServiceAccountCallback	Node-style callback called with the error, if any, and AccessApprovalServiceAccount

Returns:

Type	Description
undefined

getAccessApprovalServiceAccount(request) → {Promise.<google.cloud.accessapproval.v1.AccessApprovalServiceAccount>}

Calls GetAccessApprovalServiceAccount.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IGetAccessApprovalServiceAccountMessage	GetAccessApprovalServiceAccountMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.AccessApprovalServiceAccount>	Promise

getAccessApprovalSettings(request, callback) → {undefined}

Calls GetAccessApprovalSettings.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage	GetAccessApprovalSettingsMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.GetAccessApprovalSettingsCallback	Node-style callback called with the error, if any, and AccessApprovalSettings

Returns:

Type	Description
undefined

getAccessApprovalSettings(request) → {Promise.<google.cloud.accessapproval.v1.AccessApprovalSettings>}

Calls GetAccessApprovalSettings.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IGetAccessApprovalSettingsMessage	GetAccessApprovalSettingsMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.AccessApprovalSettings>	Promise

getApprovalRequest(request, callback) → {undefined}

Calls GetApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IGetApprovalRequestMessage	GetApprovalRequestMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.GetApprovalRequestCallback	Node-style callback called with the error, if any, and ApprovalRequest

Returns:

Type	Description
undefined

getApprovalRequest(request) → {Promise.<google.cloud.accessapproval.v1.ApprovalRequest>}

Calls GetApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IGetApprovalRequestMessage	GetApprovalRequestMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.ApprovalRequest>	Promise

invalidateApprovalRequest(request, callback) → {undefined}

Calls InvalidateApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage	InvalidateApprovalRequestMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.InvalidateApprovalRequestCallback	Node-style callback called with the error, if any, and ApprovalRequest

Returns:

Type	Description
undefined

invalidateApprovalRequest(request) → {Promise.<google.cloud.accessapproval.v1.ApprovalRequest>}

Calls InvalidateApprovalRequest.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IInvalidateApprovalRequestMessage	InvalidateApprovalRequestMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.ApprovalRequest>	Promise

listApprovalRequests(request, callback) → {undefined}

Calls ListApprovalRequests.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IListApprovalRequestsMessage	ListApprovalRequestsMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.ListApprovalRequestsCallback	Node-style callback called with the error, if any, and ListApprovalRequestsResponse

Returns:

Type	Description
undefined

listApprovalRequests(request) → {Promise.<google.cloud.accessapproval.v1.ListApprovalRequestsResponse>}

Calls ListApprovalRequests.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IListApprovalRequestsMessage	ListApprovalRequestsMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.ListApprovalRequestsResponse>	Promise

updateAccessApprovalSettings(request, callback) → {undefined}

Calls UpdateAccessApprovalSettings.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage	UpdateAccessApprovalSettingsMessage message or plain object
`callback`	google.cloud.accessapproval.v1.AccessApproval.UpdateAccessApprovalSettingsCallback	Node-style callback called with the error, if any, and AccessApprovalSettings

Returns:

Type	Description
undefined

updateAccessApprovalSettings(request) → {Promise.<google.cloud.accessapproval.v1.AccessApprovalSettings>}

Calls UpdateAccessApprovalSettings.

Parameters:

Name	Type	Description
`request`	google.cloud.accessapproval.v1.IUpdateAccessApprovalSettingsMessage	UpdateAccessApprovalSettingsMessage message or plain object

Returns:

Type	Description
Promise.<google.cloud.accessapproval.v1.AccessApprovalSettings>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {AccessApproval}

Creates new AccessApproval service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
AccessApproval	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

ApproveApprovalRequestCallback(error, responseopt)

Callback as used by approveApprovalRequest.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.ApprovalRequest	<optional>	ApprovalRequest

DeleteAccessApprovalSettingsCallback(error, responseopt)

Callback as used by deleteAccessApprovalSettings.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DismissApprovalRequestCallback(error, responseopt)

Callback as used by dismissApprovalRequest.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.ApprovalRequest	<optional>	ApprovalRequest

GetAccessApprovalServiceAccountCallback(error, responseopt)

Callback as used by getAccessApprovalServiceAccount.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.AccessApprovalServiceAccount	<optional>	AccessApprovalServiceAccount

GetAccessApprovalSettingsCallback(error, responseopt)

Callback as used by getAccessApprovalSettings.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.AccessApprovalSettings	<optional>	AccessApprovalSettings

GetApprovalRequestCallback(error, responseopt)

Callback as used by getApprovalRequest.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.ApprovalRequest	<optional>	ApprovalRequest

InvalidateApprovalRequestCallback(error, responseopt)

Callback as used by invalidateApprovalRequest.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.ApprovalRequest	<optional>	ApprovalRequest

ListApprovalRequestsCallback(error, responseopt)

Callback as used by listApprovalRequests.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.ListApprovalRequestsResponse	<optional>	ListApprovalRequestsResponse

UpdateAccessApprovalSettingsCallback(error, responseopt)

Callback as used by updateAccessApprovalSettings.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.accessapproval.v1.AccessApprovalSettings	<optional>	AccessApprovalSettings