Package org.azd.policy.configurations

Class ConfigurationsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.policy.configurations.ConfigurationsRequestBuilder

public class ConfigurationsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Policy configurations Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigurationsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	ConfigurationsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

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
ConfigurationsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
PolicyConfiguration	create(PolicyConfiguration policyConfiguration)	Create a policy configuration of a given policy type.
CompletableFuture<PolicyConfiguration>	createAsync(PolicyConfiguration policyConfiguration)	Create a policy configuration of a given policy type.
Void	delete(int configurationId)	Delete a policy configuration by its ID.
CompletableFuture<Void>	deleteAsync(int configurationId)	Delete a policy configuration by its ID.
PolicyConfiguration	get(int configurationId)	Get a policy configuration by its ID.
CompletableFuture<PolicyConfiguration>	getAsync(int configurationId)	Get a policy configuration by its ID.
PolicyConfigurations	list()	Get a list of policy configurations in a project.
PolicyConfigurations	list(Consumer<ConfigurationsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of policy configurations in a project.
CompletableFuture<PolicyConfigurations>	listAsync()	Get a list of policy configurations in a project.
CompletableFuture<PolicyConfigurations>	listAsync(Consumer<ConfigurationsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of policy configurations in a project.
PolicyConfiguration	update(int configurationId, PolicyConfiguration policyConfiguration)	Update a policy configuration by its ID.
CompletableFuture<PolicyConfiguration>	updateAsync(int configurationId, PolicyConfiguration policyConfiguration)	Update a policy configuration by its ID.

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

ConfigurationsRequestBuilder

public ConfigurationsRequestBuilder(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

createAsync

public CompletableFuture<PolicyConfiguration> createAsync(PolicyConfiguration policyConfiguration)
                                                   throws AzDException

Create a policy configuration of a given policy type.

Parameters:

policyConfiguration - Policy configuration object to create policy. PolicyConfiguration

Returns:

Policy configuration object. PolicyConfiguration

Throws:

AzDException - Default Api exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int configurationId)
                                    throws AzDException

Delete a policy configuration by its ID.

Parameters:

configurationId - ID of the policy configuration to delete.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<PolicyConfiguration> getAsync(int configurationId)
                                                throws AzDException

Get a policy configuration by its ID.

Parameters:

configurationId - ID of the policy configuration

Returns:

PolicyConfiguration object PolicyConfiguration

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<PolicyConfigurations> listAsync()
                                                  throws AzDException

Get a list of policy configurations in a project.

Returns:

PolicyConfigurations object PolicyConfigurations

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<PolicyConfigurations> listAsync(Consumer<ConfigurationsRequestBuilder.RequestConfiguration> requestConfiguration)
                                                  throws AzDException

Get a list of policy configurations in a project.

The 'scope' parameter for this API should not be used, except for legacy compatibility reasons. It returns specifically scoped policies and does not support hierarchical nesting. Instead, use the /_apis/git/policy/configurations API, which provides first class scope filtering support.

The optional policyType parameter can be used to filter the set of policies returned from this method.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

PolicyConfigurations object PolicyConfigurations

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<PolicyConfiguration> updateAsync(int configurationId,
 PolicyConfiguration policyConfiguration)
                                                   throws AzDException

Update a policy configuration by its ID.

Parameters:

configurationId - ID of the existing policy configuration to be updated.

policyConfiguration - Policy configuration object. Use get method to get policy, edit it and then use the PolicyConfiguration object with this method to update.

Returns:

PolicyConfiguration object PolicyConfiguration

Throws:

AzDException - Default Api Exception handler.

create

public PolicyConfiguration create(PolicyConfiguration policyConfiguration)
                           throws AzDException

Create a policy configuration of a given policy type.

Parameters:

policyConfiguration - Policy configuration object to create policy. PolicyConfiguration

Returns:

Policy configuration object. PolicyConfiguration

Throws:

AzDException - Default Api exception handler.

delete

public Void delete(int configurationId)
            throws AzDException

Delete a policy configuration by its ID.

Parameters:

configurationId - ID of the policy configuration to delete.

Throws:

AzDException - Default Api Exception handler.

get

public PolicyConfiguration get(int configurationId)
                        throws AzDException

Get a policy configuration by its ID.

Parameters:

configurationId - ID of the policy configuration

Returns:

PolicyConfiguration object PolicyConfiguration

Throws:

AzDException - Default Api Exception handler.

list

public PolicyConfigurations list()
                          throws AzDException

Get a list of policy configurations in a project.

Returns:

PolicyConfigurations object PolicyConfigurations

Throws:

AzDException - Default Api Exception handler.

list

public PolicyConfigurations list(Consumer<ConfigurationsRequestBuilder.RequestConfiguration> requestConfiguration)
                          throws AzDException

Get a list of policy configurations in a project.

The 'scope' parameter for this API should not be used, except for legacy compatibility reasons. It returns specifically scoped policies and does not support hierarchical nesting. Instead, use the /_apis/git/policy/configurations API, which provides first class scope filtering support.

The optional policyType parameter can be used to filter the set of policies returned from this method.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

PolicyConfigurations object PolicyConfigurations

Throws:

AzDException - Default Api Exception handler.

update

public PolicyConfiguration update(int configurationId,
 PolicyConfiguration policyConfiguration)
                           throws AzDException

Update a policy configuration by its ID.

Parameters:

configurationId - ID of the existing policy configuration to be updated.

policyConfiguration - Policy configuration object. Use get method to get policy, edit it and then use the PolicyConfiguration object with this method to update.

Returns:

PolicyConfiguration object PolicyConfiguration

Throws:

AzDException - Default Api Exception handler.