Class AbacPoliciesClient

Index

Constructors

Methods

createPolicy deletePolicy getPolicy listPolicies listPoliciesIter updatePolicy

Constructors

constructor

new AbacPoliciesClient(options: ClientOptions): AbacPoliciesClient
Parameters
- options: ClientOptions
Returns AbacPoliciesClient
- Defined in client.ts:54

Methods

createPolicy

createPolicy(
req: CreatePolicyRequest,
options?: CallOptions,
): Promise<PolicyInfo>
Creates a new policy on a securable. The new policy applies to the securable and all its descendants.
Parameters
- req: CreatePolicyRequest
- Optionaloptions: CallOptions
Returns Promise<PolicyInfo>
- Defined in client.ts:73

deletePolicy

deletePolicy(
req: DeletePolicyRequest,
options?: CallOptions,
): Promise<DeletePolicyResponse>
Delete an ABAC policy defined on a securable.
Parameters
- req: DeletePolicyRequest
- Optionaloptions: CallOptions
Returns Promise<DeletePolicyResponse>
- Defined in client.ts:103

getPolicy

getPolicy(req: GetPolicyRequest, options?: CallOptions): Promise<PolicyInfo>
Get the policy definition on a securable
Parameters
- req: GetPolicyRequest
- Optionaloptions: CallOptions
Returns Promise<PolicyInfo>
- Defined in client.ts:132

listPolicies

listPolicies(
req: ListPoliciesRequest,
options?: CallOptions,
): Promise<ListPoliciesResponse>
List all policies defined on a securable. Optionally, the list can include inherited policies defined on the securable's parent schema or catalog.

PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
Parameters
- req: ListPoliciesRequest
- Optionaloptions: CallOptions
Returns Promise<ListPoliciesResponse>
- Defined in client.ts:167

listPoliciesIter

listPoliciesIter(
req: ListPoliciesRequest,
options?: CallOptions,
): AsyncGenerator<PolicyInfo>
Parameters
- req: ListPoliciesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<PolicyInfo>
- Defined in client.ts:207

updatePolicy

updatePolicy(
req: UpdatePolicyRequest,
options?: CallOptions,
): Promise<PolicyInfo>
Update an ABAC policy on a securable.
Parameters
- req: UpdatePolicyRequest
- Optionaloptions: CallOptions
Returns Promise<PolicyInfo>
- Defined in client.ts:225