Package org.azd.distributedtask.environments

Class EnvironmentsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.distributedtask.environments.EnvironmentsRequestBuilder

public class EnvironmentsRequestBuilder
extends BaseRequestBuilder

Grant ability to manage distributed task environments Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
EnvironmentInstance	add(String name, String description)	Create an environment.
CompletableFuture<EnvironmentInstance>	addAsync(String name, String description)	Create an environment.
Void	delete(int environmentId)	Delete the specified environment.
CompletableFuture<Void>	deleteAsync(int environmentId)	Delete the specified environment.
EnvironmentInstance	get(int environmentId)	Get an environment by its ID.
EnvironmentInstance	get(int environmentId, EnvironmentExpands expands)	Get an environment by its ID.
CompletableFuture<EnvironmentInstance>	getAsync(int environmentId)	Get an environment by its ID.
CompletableFuture<EnvironmentInstance>	getAsync(int environmentId, EnvironmentExpands expands)	Get an environment by its ID.
EnvironmentInstances	list()	Get all environments.
EnvironmentInstances	list(Consumer<EnvironmentsRequestBuilder.RequestConfiguration> requestConfiguration)	Get all environments.
CompletableFuture<EnvironmentInstances>	listAsync()	Get all environments.
CompletableFuture<EnvironmentInstances>	listAsync(Consumer<EnvironmentsRequestBuilder.RequestConfiguration> requestConfiguration)	Get all environments.
EnvironmentInstance	update(int environmentId, String name, String description)	Update the specified environment.
CompletableFuture<EnvironmentInstance>	updateAsync(int environmentId, String name, String description)	Update the specified environment.

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

EnvironmentsRequestBuilder

public EnvironmentsRequestBuilder(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<EnvironmentInstance> addAsync(String name,
 String description)
                                                throws AzDException

Create an environment.

Parameters:

name - Name of the environment.

description - Description of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

deleteAsync

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

Delete the specified environment.

Parameters:

environmentId - ID of the environment.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<EnvironmentInstance> getAsync(int environmentId)
                                                throws AzDException

Get an environment by its ID.

Parameters:

environmentId - ID of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<EnvironmentInstance> getAsync(int environmentId,
 EnvironmentExpands expands)
                                                throws AzDException

Get an environment by its ID.

Parameters:

environmentId - ID of the environment.

expands - Include these additional details in the returned objects. EnvironmentExpands

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<EnvironmentInstances> listAsync()
                                                  throws AzDException

Get all environments.

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<EnvironmentInstances> listAsync(Consumer<EnvironmentsRequestBuilder.RequestConfiguration> requestConfiguration)
                                                  throws AzDException

Get all environments.

Parameters:

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

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<EnvironmentInstance> updateAsync(int environmentId,
 String name,
 String description)
                                                   throws AzDException

Update the specified environment.

Parameters:

environmentId - ID of the environment.

name - Name of the environment.

description - Description of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

add

public EnvironmentInstance add(String name,
 String description)
                        throws AzDException

Create an environment.

Parameters:

name - Name of the environment.

description - Description of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int environmentId)
            throws AzDException

Delete the specified environment.

Parameters:

environmentId - ID of the environment.

Throws:

AzDException - Default Api Exception handler.

get

public EnvironmentInstance get(int environmentId)
                        throws AzDException

Get an environment by its ID.

Parameters:

environmentId - ID of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

get

public EnvironmentInstance get(int environmentId,
 EnvironmentExpands expands)
                        throws AzDException

Get an environment by its ID.

Parameters:

environmentId - ID of the environment.

expands - Include these additional details in the returned objects. EnvironmentExpands

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

list

public EnvironmentInstances list()
                          throws AzDException

Get all environments.

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

list

public EnvironmentInstances list(Consumer<EnvironmentsRequestBuilder.RequestConfiguration> requestConfiguration)
                          throws AzDException

Get all environments.

Parameters:

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

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

update

public EnvironmentInstance update(int environmentId,
 String name,
 String description)
                           throws AzDException

Update the specified environment.

Parameters:

environmentId - ID of the environment.

name - Name of the environment.

description - Description of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.