Class ClusterPoliciesClient

Index

Constructors

Methods

createPolicy deletePolicy editPolicy getPolicy listComputePolicies listComputePoliciesIter listPolicies listServerlessComputes listServerlessComputesIter

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

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

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

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

listComputePolicies

listComputePolicies(
req: ListComputePoliciesRequest,
options?: CallOptions,
): Promise<ListComputePoliciesResponse>
Lists compute policies in the workspace. Results are returned in an unspecified order; callers should sort client-side if a specific order is needed.
Parameters
- req: ListComputePoliciesRequest
- Optionaloptions: CallOptions
Returns Promise<ListComputePoliciesResponse>
- Defined in client.ts:250

listComputePoliciesIter

listComputePoliciesIter(
req: ListComputePoliciesRequest,
options?: CallOptions,
): AsyncGenerator<ComputePolicy>
Parameters
- req: ListComputePoliciesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ComputePolicy>
- Defined in client.ts:290

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

listServerlessComputes

listServerlessComputes(
req: ListServerlessComputesRequest,
options?: CallOptions,
): Promise<ListServerlessComputesResponse>
Lists Interactive serverless computes that the caller can use or manage. Results are returned in an unspecified order.
Parameters
- req: ListServerlessComputesRequest
- Optionaloptions: CallOptions
Returns Promise<ListServerlessComputesResponse>
- Defined in client.ts:311

listServerlessComputesIter

listServerlessComputesIter(
req: ListServerlessComputesRequest,
options?: CallOptions,
): AsyncGenerator<ServerlessCompute>
Parameters
- req: ListServerlessComputesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ServerlessCompute>
- Defined in client.ts:351