Package org.azd.pipelines.permissions

Class PermissionsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.pipelines.permissions.PermissionsRequestBuilder

public class PermissionsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Pipelines permissions 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
PermissionsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
ResourcePipelinePermission	get(String resourceId, String resourceType)	Given a ResourceType and ResourceId, returns authorized definitions for that resource.
CompletableFuture<ResourcePipelinePermission>	getAsync(String resourceId, String resourceType)	Given a ResourceType and ResourceId, returns authorized definitions for that resource.
ResourcePipelinePermission	update(String resourceId, String resourceType, ResourcePipelinePermission resource)	Authorizes/Unauthorizes a list of definitions for a given resource.
ResourcePipelinePermissions	update(List<ResourcePipelinePermission> resources)	Batch requests to authorize/unauthorize a list of definitions for a multiple resources.
CompletableFuture<ResourcePipelinePermission>	updateAsync(String resourceId, String resourceType, ResourcePipelinePermission resource)	Authorizes/Unauthorizes a list of definitions for a given resource.
CompletableFuture<ResourcePipelinePermissions>	updateAsync(List<ResourcePipelinePermission> resources)	Batch requests to authorize/unauthorize a list of definitions for a multiple resources.

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

PermissionsRequestBuilder

public PermissionsRequestBuilder(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<ResourcePipelinePermission> getAsync(String resourceId,
 String resourceType)
                                                       throws AzDException

Given a ResourceType and ResourceId, returns authorized definitions for that resource.

Parameters:

resourceId - Id of the resource

resourceType - Type of the resource

Returns:

ResourcePipelinePermissions Object ResourcePipelinePermission

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ResourcePipelinePermission> updateAsync(String resourceId,
 String resourceType,
 ResourcePipelinePermission resource)
                                                          throws AzDException

Authorizes/Unauthorizes a list of definitions for a given resource.

Parameters:

resourceId - Id of the resource

resourceType - Type of the resource

resource - Resource request object to authorize the request Example:

                  var resource = new ResourcePipelinePermission();
                  var pipelinePermission = new PipelinePermission();
                  pipelinePermission.setAuthorized(true);
                  pipelinePermission.setId(16);
                  resource.setPipelines(List.of(pipelinePermission));
                 

Returns:

ResourcePipelinePermissions Object ResourcePipelinePermission

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ResourcePipelinePermissions> updateAsync(List<ResourcePipelinePermission> resources)
                                                           throws AzDException

Batch requests to authorize/unauthorize a list of definitions for a multiple resources.

Parameters:

resources - Resource request object to authorize the request Example:

                  var resourcePipelinePermission = new ResourcePipelinePermission();
                  var resourcePipelinePermission1 = new ResourcePipelinePermission();

                  var resource = new Resource();
                  resource.setId("1");
                  resource.setName("Default");
                  resource.setType("queue");

                  var resource1 = new Resource();
                  resource1.setId("1");
                  resource1.setName("SampleEnv");
                  resource1.setType("environment");

                  var pipelinePermission = new PipelinePermission();
                  pipelinePermission.setAuthorized(true);
                  pipelinePermission.setId(16);

                  resourcePipelinePermission.setResource(resource);
                  resourcePipelinePermission.setPipelines(List.of(pipelinePermission));

                  resourcePipelinePermission1.setResource(resource1);
                  resourcePipelinePermission1.setPipelines(List.of(pipelinePermission));
                 

Returns:

ResourcePipelinePermissions Object ResourcePipelinePermission

Throws:

AzDException - Default Api Exception handler.

get

public ResourcePipelinePermission get(String resourceId,
 String resourceType)
                               throws AzDException

Given a ResourceType and ResourceId, returns authorized definitions for that resource.

Parameters:

resourceId - Id of the resource

resourceType - Type of the resource

Returns:

ResourcePipelinePermissions Object ResourcePipelinePermission

Throws:

AzDException - Default Api Exception handler.

update

public ResourcePipelinePermission update(String resourceId,
 String resourceType,
 ResourcePipelinePermission resource)
                                  throws AzDException

Authorizes/Unauthorizes a list of definitions for a given resource.

Parameters:

resourceId - Id of the resource

resourceType - Type of the resource

resource - Resource request object to authorize the request Example:

                  var resource = new ResourcePipelinePermission();
                  var pipelinePermission = new PipelinePermission();
                  pipelinePermission.setAuthorized(true);
                  pipelinePermission.setId(16);
                  resource.setPipelines(List.of(pipelinePermission));
                 

Returns:

ResourcePipelinePermissions Object ResourcePipelinePermission

Throws:

AzDException - Default Api Exception handler.

update

public ResourcePipelinePermissions update(List<ResourcePipelinePermission> resources)
                                   throws AzDException

Batch requests to authorize/unauthorize a list of definitions for a multiple resources.

Parameters:

resources - Resource request object to authorize the request Example:

                  var resourcePipelinePermission = new ResourcePipelinePermission();
                  var resourcePipelinePermission1 = new ResourcePipelinePermission();

                  var resource = new Resource();
                  resource.setId("1");
                  resource.setName("Default");
                  resource.setType("queue");

                  var resource1 = new Resource();
                  resource1.setId("1");
                  resource1.setName("SampleEnv");
                  resource1.setType("environment");

                  var pipelinePermission = new PipelinePermission();
                  pipelinePermission.setAuthorized(true);
                  pipelinePermission.setId(16);

                  resourcePipelinePermission.setResource(resource);
                  resourcePipelinePermission.setPipelines(List.of(pipelinePermission));

                  resourcePipelinePermission1.setResource(resource1);
                  resourcePipelinePermission1.setPipelines(List.of(pipelinePermission));
                 

Returns:

ResourcePipelinePermissions Object ResourcePipelinePermission

Throws:

AzDException - Default Api Exception handler.