Class ClusterPoliciesClient

Index

Constructors

Methods

createPolicy deletePolicy editPolicy getPolicy listPolicies

Constructors

constructor

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

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:76

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:106

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:136

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:166

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:201