Package org.azd.policy.policytypes

Class TypesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.policy.policytypes.TypesRequestBuilder

public class TypesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Policy Types Api.

Nested Class Summary

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
TypesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
PolicyType	get(String typeId)	Retrieve a specific policy type by ID.
CompletableFuture<PolicyType>	getAsync(String typeId)	Retrieve a specific policy type by ID.
PolicyTypes	list()	Retrieve all available policy types.
CompletableFuture<PolicyTypes>	listAsync()	Retrieve all available policy types.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

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

Constructor Details

TypesRequestBuilder

public TypesRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

getAsync

public CompletableFuture<PolicyType> getAsync(String typeId)
                                       throws AzDException

Retrieve a specific policy type by ID.

Parameters:

typeId - Guid of the configuration policy type.

Returns:

PolicyType object PolicyType

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<PolicyTypes> listAsync()
                                         throws AzDException

Retrieve all available policy types.

Returns:

PolicyTypes object PolicyTypes

Throws:

AzDException - Default Api Exception handler.

get

public PolicyType get(String typeId)
               throws AzDException

Retrieve a specific policy type by ID.

Parameters:

typeId - Guid of the configuration policy type.

Returns:

PolicyType object PolicyType

Throws:

AzDException - Default Api Exception handler.

list

public PolicyTypes list()
                 throws AzDException

Retrieve all available policy types.

Returns:

PolicyTypes object PolicyTypes

Throws:

AzDException - Default Api Exception handler.