com.databricks.sdk.service.compute

Class PolicyFamiliesAPI

java.lang.Object

com.databricks.sdk.service.compute.PolicyFamiliesAPI

@Generated
public class PolicyFamiliesAPI
extends Object

View available policy families. A policy family contains a policy definition providing best practices for configuring clusters for a particular use case.

Databricks manages and provides policy families for several common cluster use cases. You cannot create, edit, or delete policy families.

Policy families cannot be used directly to create clusters. Instead, you create cluster policies using a policy family. Cluster policies created using a policy family inherit the policy family's policy definition.

Constructor Summary

Constructors

Constructor and Description
PolicyFamiliesAPI(ApiClient apiClient) Regular-use constructor
PolicyFamiliesAPI(PolicyFamiliesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
PolicyFamily	get(GetPolicyFamilyRequest request) Get policy family information.
PolicyFamily	get(String policyFamilyId)
PolicyFamiliesService	impl()
Iterable<PolicyFamily>	list(ListPolicyFamiliesRequest request) List policy families.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyFamiliesAPI

public PolicyFamiliesAPI(ApiClient apiClient)

Regular-use constructor

PolicyFamiliesAPI

public PolicyFamiliesAPI(PolicyFamiliesService mock)

Constructor for mocks

Method Detail

get

public PolicyFamily get(String policyFamilyId)

get

public PolicyFamily get(GetPolicyFamilyRequest request)

Get policy family information.

Retrieve the information for an policy family based on its identifier and version

list

public Iterable<PolicyFamily> list(ListPolicyFamiliesRequest request)

List policy families.

Returns the list of policy definition types available to use at their latest version. This API is paginated.

impl

public PolicyFamiliesService impl()