Package org.azd.distributedtask.variablegroups

Class VariableGroupsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.distributedtask.variablegroups.VariableGroupsRequestBuilder

public class VariableGroupsRequestBuilder
extends BaseRequestBuilder

Grant ability to manage distributed task environments Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VariableGroupsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	VariableGroupsRequestBuilder.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
VariableGroupsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
VariableGroup	add(VariableGroupLibrary variableGroupLibrary)	Add a variable group.
CompletableFuture<VariableGroup>	addAsync(VariableGroupLibrary variableGroupLibrary)	Add a variable group.
Void	delete(int variableGroupId, String[] projectIds)	Delete a variable group
CompletableFuture<Void>	deleteAsync(int variableGroupId, String[] projectIds)	Delete a variable group
VariableGroup	get(int variableGroupId)	Get a variable group.
VariableGroup	get(int variableGroupId, String[] groupIds)	Get variable groups by Ids.
CompletableFuture<VariableGroup>	getAsync(int variableGroupId)	Get a variable group.
CompletableFuture<VariableGroup>	getAsync(int variableGroupId, String[] groupIds)	Get variable groups by Ids.
VariableGroups	list()	Get variable groups.
VariableGroups	list(Consumer<VariableGroupsRequestBuilder.RequestConfiguration> requestConfiguration)	Get variable groups.
CompletableFuture<VariableGroups>	listAsync()	Get variable groups.
CompletableFuture<VariableGroups>	listAsync(Consumer<VariableGroupsRequestBuilder.RequestConfiguration> requestConfiguration)	Get variable groups.
Void	share(int variableGroupId, List<VariableGroupProjectReference> variableGroupProjectReferences)	Add a variable group.
CompletableFuture<Void>	shareAsync(int variableGroupId, List<VariableGroupProjectReference> variableGroupProjectReferences)	Add a variable group.
VariableGroup	update(int variableGroupId, VariableGroupLibrary variableGroupLibrary)	Update a variable group.
CompletableFuture<VariableGroup>	updateAsync(int variableGroupId, VariableGroupLibrary variableGroupLibrary)	Update a variable group.

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

VariableGroupsRequestBuilder

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

addAsync

public CompletableFuture<VariableGroup> addAsync(VariableGroupLibrary variableGroupLibrary)
                                          throws AzDException

Add a variable group.

Parameters:

variableGroupLibrary - Request body of variable group VariableGroupLibrary

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int variableGroupId,
 String[] projectIds)
                                    throws AzDException

Delete a variable group

Parameters:

variableGroupId - Id of the variable group.

projectIds - String array of project ids.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<VariableGroup> getAsync(int variableGroupId)
                                          throws AzDException

Get a variable group.

Parameters:

variableGroupId - Id of the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<VariableGroups> listAsync()
                                            throws AzDException

Get variable groups.

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<VariableGroups> listAsync(Consumer<VariableGroupsRequestBuilder.RequestConfiguration> requestConfiguration)
                                            throws AzDException

Get variable groups.

Parameters:

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<VariableGroup> getAsync(int variableGroupId,
 String[] groupIds)
                                          throws AzDException

Get variable groups by Ids.

Parameters:

variableGroupId - Id of the variable group.

groupIds - String array of Ids of variable group ids.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

shareAsync

public CompletableFuture<Void> shareAsync(int variableGroupId,
 List<VariableGroupProjectReference> variableGroupProjectReferences)
                                   throws AzDException

Add a variable group. This corresponds to VariableGroups - Share Variable Group.

Parameters:

variableGroupId - Id of the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

See Also:

• Share Variable Group

updateAsync

public CompletableFuture<VariableGroup> updateAsync(int variableGroupId,
 VariableGroupLibrary variableGroupLibrary)
                                             throws AzDException

Update a variable group.

Parameters:

variableGroupId - Id of the variable group.

variableGroupLibrary - Request body to update the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

add

public VariableGroup add(VariableGroupLibrary variableGroupLibrary)
                  throws AzDException

Add a variable group.

Parameters:

variableGroupLibrary - Request body of variable group VariableGroupLibrary

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int variableGroupId,
 String[] projectIds)
            throws AzDException

Delete a variable group

Parameters:

variableGroupId - Id of the variable group.

projectIds - String array of project ids.

Throws:

AzDException - Default Api Exception handler.

get

public VariableGroup get(int variableGroupId)
                  throws AzDException

Get a variable group.

Parameters:

variableGroupId - Id of the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

list

public VariableGroups list()
                    throws AzDException

Get variable groups.

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

list

public VariableGroups list(Consumer<VariableGroupsRequestBuilder.RequestConfiguration> requestConfiguration)
                    throws AzDException

Get variable groups.

Parameters:

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

get

public VariableGroup get(int variableGroupId,
 String[] groupIds)
                  throws AzDException

Get variable groups by Ids.

Parameters:

variableGroupId - Id of the variable group.

groupIds - String array of Ids of variable group ids.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

share

public Void share(int variableGroupId,
 List<VariableGroupProjectReference> variableGroupProjectReferences)
           throws AzDException

Add a variable group. This corresponds to VariableGroups - Share Variable Group.

Parameters:

variableGroupId - Id of the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

See Also:

• Share Variable Group

update

public VariableGroup update(int variableGroupId,
 VariableGroupLibrary variableGroupLibrary)
                     throws AzDException

Update a variable group.

Parameters:

variableGroupId - Id of the variable group.

variableGroupLibrary - Request body to update the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.