Class PolicyFamiliesClient

Index

Constructors

Methods

getPolicyFamily listPolicyFamilies listPolicyFamiliesIter

Constructors

constructor

new PolicyFamiliesClient(options: ClientOptions): PolicyFamiliesClient
Parameters
- options: ClientOptions
Returns PolicyFamiliesClient
- Defined in client.ts:47

Methods

getPolicyFamily

getPolicyFamily(
req: GetPolicyFamilyRequest,
options?: CallOptions,
): Promise<PolicyFamily>
Retrieve the information for an policy family based on its identifier and version
Parameters
- req: GetPolicyFamilyRequest
- Optionaloptions: CallOptions
Returns Promise<PolicyFamily>
- Defined in client.ts:63

listPolicyFamilies

listPolicyFamilies(
req: ListPolicyFamiliesRequest,
options?: CallOptions,
): Promise<ListPolicyFamiliesResponse>
Returns the list of policy definition types available to use at their latest version. This API is paginated.
Parameters
- req: ListPolicyFamiliesRequest
- Optionaloptions: CallOptions
Returns Promise<ListPolicyFamiliesResponse>
- Defined in client.ts:98

listPolicyFamiliesIter

listPolicyFamiliesIter(
req: ListPolicyFamiliesRequest,
options?: CallOptions,
): AsyncGenerator<PolicyFamily>
Parameters
- req: ListPolicyFamiliesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<PolicyFamily>
- Defined in client.ts:135