Class ClusterPoliciesClient

Index

Constructors

Methods

createPolicy deletePolicy editPolicy getClusterPolicyRevision getPolicy listClusterPolicyRevisions listClusterPolicyRevisionsIter listPolicies rollbackClusterPolicy

Constructors

constructor

new ClusterPoliciesClient(options: ClientOptions): ClusterPoliciesClient
Parameters
- options: ClientOptions
Returns ClusterPoliciesClient
- Defined in client.ts:68

Methods

createPolicy

createPolicy(
req: CreatePolicyRequest,
options?: CallOptions,
): Promise<CreatePolicyResponse>
Creates a new policy with prescribed settings.
Parameters
- req: CreatePolicyRequest
- Optionaloptions: CallOptions
Returns Promise<CreatePolicyResponse>
- Defined in client.ts:201

deletePolicy

deletePolicy(
req: DeletePolicyRequest,
options?: CallOptions,
): Promise<DeletePolicyResponse>
Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.
Parameters
- req: DeletePolicyRequest
- Optionaloptions: CallOptions
Returns Promise<DeletePolicyResponse>
- Defined in client.ts:231

editPolicy

editPolicy(
req: EditPolicyRequest,
options?: CallOptions,
): Promise<EditPolicyResponse>
Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.
Parameters
- req: EditPolicyRequest
- Optionaloptions: CallOptions
Returns Promise<EditPolicyResponse>
- Defined in client.ts:261

getClusterPolicyRevision

getClusterPolicyRevision(
req: GetClusterPolicyRevisionRequest,
options?: CallOptions,
): Promise<ClusterPolicyRevision>
Get details of a cluster policy revision.
Parameters
- req: GetClusterPolicyRevisionRequest
- Optionaloptions: CallOptions
Returns Promise<ClusterPolicyRevision>
- Defined in client.ts:84

getPolicy

getPolicy(req: GetPolicyRequest, options?: CallOptions): Promise<Policy>
Get a cluster policy entity. Creation and editing is available to admins only.
Parameters
- req: GetPolicyRequest
- Optionaloptions: CallOptions
Returns Promise<Policy>
- Defined in client.ts:291

listClusterPolicyRevisions

listClusterPolicyRevisions(
req: ListClusterPolicyRevisionsRequest,
options?: CallOptions,
): Promise<ListClusterPolicyRevisionsResponse>
Lists a cluster policy's revisions, ordered from most to least recent.
Parameters
- req: ListClusterPolicyRevisionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListClusterPolicyRevisionsResponse>
- Defined in client.ts:113

listClusterPolicyRevisionsIter

listClusterPolicyRevisionsIter(
req: ListClusterPolicyRevisionsRequest,
options?: CallOptions,
): AsyncGenerator<ClusterPolicyRevision>
Parameters
- req: ListClusterPolicyRevisionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ClusterPolicyRevision>
- Defined in client.ts:153

listPolicies

listPolicies(
req: ListPoliciesRequest,
options?: CallOptions,
): Promise<ListPoliciesResponse>
Returns a list of policies accessible by the requesting user.
Parameters
- req: ListPoliciesRequest
- Optionaloptions: CallOptions
Returns Promise<ListPoliciesResponse>
- Defined in client.ts:326

rollbackClusterPolicy

rollbackClusterPolicy(
req: RollbackClusterPolicyRequest,
options?: CallOptions,
): Promise<ClusterPolicyRevision>
Rolls back a cluster policy to a previous revision.
Parameters
- req: RollbackClusterPolicyRequest
- Optionaloptions: CallOptions
Returns Promise<ClusterPolicyRevision>
- Defined in client.ts:171