Class protos.google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager (0.4.0)

Represents a PrivilegedAccessManager

Inheritance

$protobuf.rpc.Service > protos.google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager

Package

@google-cloud/privilegedaccessmanager

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new PrivilegedAccessManager service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

approveGrant(request, callback)

public approveGrant(request: google.cloud.privilegedaccessmanager.v1.IApproveGrantRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.ApproveGrantCallback): void;

Calls ApproveGrant.

Parameters
Name Description
request IApproveGrantRequest

ApproveGrantRequest message or plain object
callback ApproveGrantCallback

Node-style callback called with the error, if any, and Grant
Returns
Type Description
void

approveGrant(request)

public approveGrant(request: google.cloud.privilegedaccessmanager.v1.IApproveGrantRequest): Promise<google.cloud.privilegedaccessmanager.v1.Grant>;

Calls ApproveGrant.

Parameter
Name Description
request IApproveGrantRequest

ApproveGrantRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.Grant>

Promise

checkOnboardingStatus(request, callback)

public checkOnboardingStatus(request: google.cloud.privilegedaccessmanager.v1.ICheckOnboardingStatusRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.CheckOnboardingStatusCallback): void;

Calls CheckOnboardingStatus.

Parameters
Name Description
request ICheckOnboardingStatusRequest

CheckOnboardingStatusRequest message or plain object
callback CheckOnboardingStatusCallback

Node-style callback called with the error, if any, and CheckOnboardingStatusResponse
Returns
Type Description
void

checkOnboardingStatus(request)

public checkOnboardingStatus(request: google.cloud.privilegedaccessmanager.v1.ICheckOnboardingStatusRequest): Promise<google.cloud.privilegedaccessmanager.v1.CheckOnboardingStatusResponse>;

Calls CheckOnboardingStatus.

Parameter
Name Description
request ICheckOnboardingStatusRequest

CheckOnboardingStatusRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.CheckOnboardingStatusResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): PrivilegedAccessManager;

Creates new PrivilegedAccessManager service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
PrivilegedAccessManager

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

createEntitlement(request, callback)

public createEntitlement(request: google.cloud.privilegedaccessmanager.v1.ICreateEntitlementRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.CreateEntitlementCallback): void;

Calls CreateEntitlement.

Parameters
Name Description
request ICreateEntitlementRequest

CreateEntitlementRequest message or plain object
callback CreateEntitlementCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createEntitlement(request)

public createEntitlement(request: google.cloud.privilegedaccessmanager.v1.ICreateEntitlementRequest): Promise<google.longrunning.Operation>;

Calls CreateEntitlement.

Parameter
Name Description
request ICreateEntitlementRequest

CreateEntitlementRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createGrant(request, callback)

public createGrant(request: google.cloud.privilegedaccessmanager.v1.ICreateGrantRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.CreateGrantCallback): void;

Calls CreateGrant.

Parameters
Name Description
request ICreateGrantRequest

CreateGrantRequest message or plain object
callback CreateGrantCallback

Node-style callback called with the error, if any, and Grant
Returns
Type Description
void

createGrant(request)

public createGrant(request: google.cloud.privilegedaccessmanager.v1.ICreateGrantRequest): Promise<google.cloud.privilegedaccessmanager.v1.Grant>;

Calls CreateGrant.

Parameter
Name Description
request ICreateGrantRequest

CreateGrantRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.Grant>

Promise

deleteEntitlement(request, callback)

public deleteEntitlement(request: google.cloud.privilegedaccessmanager.v1.IDeleteEntitlementRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.DeleteEntitlementCallback): void;

Calls DeleteEntitlement.

Parameters
Name Description
request IDeleteEntitlementRequest

DeleteEntitlementRequest message or plain object
callback DeleteEntitlementCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteEntitlement(request)

public deleteEntitlement(request: google.cloud.privilegedaccessmanager.v1.IDeleteEntitlementRequest): Promise<google.longrunning.Operation>;

Calls DeleteEntitlement.

Parameter
Name Description
request IDeleteEntitlementRequest

DeleteEntitlementRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

denyGrant(request, callback)

public denyGrant(request: google.cloud.privilegedaccessmanager.v1.IDenyGrantRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.DenyGrantCallback): void;

Calls DenyGrant.

Parameters
Name Description
request IDenyGrantRequest

DenyGrantRequest message or plain object
callback DenyGrantCallback

Node-style callback called with the error, if any, and Grant
Returns
Type Description
void

denyGrant(request)

public denyGrant(request: google.cloud.privilegedaccessmanager.v1.IDenyGrantRequest): Promise<google.cloud.privilegedaccessmanager.v1.Grant>;

Calls DenyGrant.

Parameter
Name Description
request IDenyGrantRequest

DenyGrantRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.Grant>

Promise

getEntitlement(request, callback)

public getEntitlement(request: google.cloud.privilegedaccessmanager.v1.IGetEntitlementRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.GetEntitlementCallback): void;

Calls GetEntitlement.

Parameters
Name Description
request IGetEntitlementRequest

GetEntitlementRequest message or plain object
callback GetEntitlementCallback

Node-style callback called with the error, if any, and Entitlement
Returns
Type Description
void

getEntitlement(request)

public getEntitlement(request: google.cloud.privilegedaccessmanager.v1.IGetEntitlementRequest): Promise<google.cloud.privilegedaccessmanager.v1.Entitlement>;

Calls GetEntitlement.

Parameter
Name Description
request IGetEntitlementRequest

GetEntitlementRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.Entitlement>

Promise

getGrant(request, callback)

public getGrant(request: google.cloud.privilegedaccessmanager.v1.IGetGrantRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.GetGrantCallback): void;

Calls GetGrant.

Parameters
Name Description
request IGetGrantRequest

GetGrantRequest message or plain object
callback GetGrantCallback

Node-style callback called with the error, if any, and Grant
Returns
Type Description
void

getGrant(request)

public getGrant(request: google.cloud.privilegedaccessmanager.v1.IGetGrantRequest): Promise<google.cloud.privilegedaccessmanager.v1.Grant>;

Calls GetGrant.

Parameter
Name Description
request IGetGrantRequest

GetGrantRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.Grant>

Promise

listEntitlements(request, callback)

public listEntitlements(request: google.cloud.privilegedaccessmanager.v1.IListEntitlementsRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.ListEntitlementsCallback): void;

Calls ListEntitlements.

Parameters
Name Description
request IListEntitlementsRequest

ListEntitlementsRequest message or plain object
callback ListEntitlementsCallback

Node-style callback called with the error, if any, and ListEntitlementsResponse
Returns
Type Description
void

listEntitlements(request)

public listEntitlements(request: google.cloud.privilegedaccessmanager.v1.IListEntitlementsRequest): Promise<google.cloud.privilegedaccessmanager.v1.ListEntitlementsResponse>;

Calls ListEntitlements.

Parameter
Name Description
request IListEntitlementsRequest

ListEntitlementsRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.ListEntitlementsResponse>

Promise

listGrants(request, callback)

public listGrants(request: google.cloud.privilegedaccessmanager.v1.IListGrantsRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.ListGrantsCallback): void;

Calls ListGrants.

Parameters
Name Description
request IListGrantsRequest

ListGrantsRequest message or plain object
callback ListGrantsCallback

Node-style callback called with the error, if any, and ListGrantsResponse
Returns
Type Description
void

listGrants(request)

public listGrants(request: google.cloud.privilegedaccessmanager.v1.IListGrantsRequest): Promise<google.cloud.privilegedaccessmanager.v1.ListGrantsResponse>;

Calls ListGrants.

Parameter
Name Description
request IListGrantsRequest

ListGrantsRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.ListGrantsResponse>

Promise

revokeGrant(request, callback)

public revokeGrant(request: google.cloud.privilegedaccessmanager.v1.IRevokeGrantRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.RevokeGrantCallback): void;

Calls RevokeGrant.

Parameters
Name Description
request IRevokeGrantRequest

RevokeGrantRequest message or plain object
callback RevokeGrantCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

revokeGrant(request)

public revokeGrant(request: google.cloud.privilegedaccessmanager.v1.IRevokeGrantRequest): Promise<google.longrunning.Operation>;

Calls RevokeGrant.

Parameter
Name Description
request IRevokeGrantRequest

RevokeGrantRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

searchEntitlements(request, callback)

public searchEntitlements(request: google.cloud.privilegedaccessmanager.v1.ISearchEntitlementsRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.SearchEntitlementsCallback): void;

Calls SearchEntitlements.

Parameters
Name Description
request ISearchEntitlementsRequest

SearchEntitlementsRequest message or plain object
callback SearchEntitlementsCallback

Node-style callback called with the error, if any, and SearchEntitlementsResponse
Returns
Type Description
void

searchEntitlements(request)

public searchEntitlements(request: google.cloud.privilegedaccessmanager.v1.ISearchEntitlementsRequest): Promise<google.cloud.privilegedaccessmanager.v1.SearchEntitlementsResponse>;

Calls SearchEntitlements.

Parameter
Name Description
request ISearchEntitlementsRequest

SearchEntitlementsRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.SearchEntitlementsResponse>

Promise

searchGrants(request, callback)

public searchGrants(request: google.cloud.privilegedaccessmanager.v1.ISearchGrantsRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.SearchGrantsCallback): void;

Calls SearchGrants.

Parameters
Name Description
request ISearchGrantsRequest

SearchGrantsRequest message or plain object
callback SearchGrantsCallback

Node-style callback called with the error, if any, and SearchGrantsResponse
Returns
Type Description
void

searchGrants(request)

public searchGrants(request: google.cloud.privilegedaccessmanager.v1.ISearchGrantsRequest): Promise<google.cloud.privilegedaccessmanager.v1.SearchGrantsResponse>;

Calls SearchGrants.

Parameter
Name Description
request ISearchGrantsRequest

SearchGrantsRequest message or plain object
Returns
Type Description
Promise<google.cloud.privilegedaccessmanager.v1.SearchGrantsResponse>

Promise

updateEntitlement(request, callback)

public updateEntitlement(request: google.cloud.privilegedaccessmanager.v1.IUpdateEntitlementRequest, callback: google.cloud.privilegedaccessmanager.v1.PrivilegedAccessManager.UpdateEntitlementCallback): void;

Calls UpdateEntitlement.

Parameters
Name Description
request IUpdateEntitlementRequest

UpdateEntitlementRequest message or plain object
callback UpdateEntitlementCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateEntitlement(request)

public updateEntitlement(request: google.cloud.privilegedaccessmanager.v1.IUpdateEntitlementRequest): Promise<google.longrunning.Operation>;

Calls UpdateEntitlement.

Parameter
Name Description
request IUpdateEntitlementRequest

UpdateEntitlementRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise