Package org.azd.graph.memberships

Class MembershipsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.graph.memberships.MembershipsRequestBuilder

public class MembershipsRequestBuilder
extends BaseRequestBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MembershipsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	MembershipsRequestBuilder.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
MembershipsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)

Method Summary

Modifier and Type	Method	Description
GraphMembership	add(String subjectDescriptor, String containerDescriptor)	Create a new membership between a container and subject.
CompletableFuture<GraphMembership>	addAsync(String subjectDescriptor, String containerDescriptor)	Create a new membership between a container and subject.
Void	checkExistence(String subjectDescriptor, String containerDescriptor)	Check to see if a membership relationship between a container and subject exists.
CompletableFuture<Void>	checkExistenceAsync(String subjectDescriptor, String containerDescriptor)	Check to see if a membership relationship between a container and subject exists.
Void	delete(String subjectDescriptor, String containerDescriptor)	Deletes a membership between a container and subject.
CompletableFuture<Void>	deleteAsync(String subjectDescriptor, String containerDescriptor)	Deletes a membership between a container and subject.
GraphMembership	get(String subjectDescriptor, String containerDescriptor)	Get a membership relationship between a container and subject.
CompletableFuture<GraphMembership>	getAsync(String subjectDescriptor, String containerDescriptor)	Get a membership relationship between a container and subject.
GraphMemberships	list(String subjectDescriptor)	Get all the memberships where this descriptor is a member in the relationship.
GraphMemberships	list(String subjectDescriptor, Consumer<MembershipsRequestBuilder.RequestConfiguration> requestConfiguration)	Get all the memberships where this descriptor is a member in the relationship.
CompletableFuture<GraphMemberships>	listAsync(String subjectDescriptor)	Get all the memberships where this descriptor is a member in the relationship.
CompletableFuture<GraphMemberships>	listAsync(String subjectDescriptor, Consumer<MembershipsRequestBuilder.RequestConfiguration> requestConfiguration)	Get all the memberships where this descriptor is a member in the relationship.

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

MembershipsRequestBuilder

public MembershipsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Method Details

addAsync

public CompletableFuture<GraphMembership> addAsync(String subjectDescriptor,
 String containerDescriptor)
                                            throws AzDException

Create a new membership between a container and subject.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Returns:

Graph membership object GraphMembership

Throws:

AzDException - Default Api exception handler.

checkExistenceAsync

public CompletableFuture<Void> checkExistenceAsync(String subjectDescriptor,
 String containerDescriptor)
                                            throws AzDException

Check to see if a membership relationship between a container and subject exists.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<GraphMembership> getAsync(String subjectDescriptor,
 String containerDescriptor)
                                            throws AzDException

Get a membership relationship between a container and subject.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Returns:

Graph membership object GraphMembership

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<GraphMemberships> listAsync(String subjectDescriptor)
                                              throws AzDException

Get all the memberships where this descriptor is a member in the relationship.

NOTE: The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

Returns:

Collection of Graph membership object GraphMemberships

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<GraphMemberships> listAsync(String subjectDescriptor,
 Consumer<MembershipsRequestBuilder.RequestConfiguration> requestConfiguration)
                                              throws AzDException

Get all the memberships where this descriptor is a member in the relationship.

NOTE: The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

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

Returns:

Collection of Graph membership object GraphMemberships

Throws:

AzDException - Default Api exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String subjectDescriptor,
 String containerDescriptor)
                                    throws AzDException

Deletes a membership between a container and subject.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Throws:

AzDException - Default Api exception handler.

add

public GraphMembership add(String subjectDescriptor,
 String containerDescriptor)
                    throws AzDException

Create a new membership between a container and subject.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Returns:

Graph membership object GraphMembership

Throws:

AzDException - Default Api exception handler.

checkExistence

public Void checkExistence(String subjectDescriptor,
 String containerDescriptor)
                    throws AzDException

Check to see if a membership relationship between a container and subject exists.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Throws:

AzDException - Default Api exception handler.

get

public GraphMembership get(String subjectDescriptor,
 String containerDescriptor)
                    throws AzDException

Get a membership relationship between a container and subject.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Returns:

Graph membership object GraphMembership

Throws:

AzDException - Default Api exception handler.

list

public GraphMemberships list(String subjectDescriptor)
                      throws AzDException

Get all the memberships where this descriptor is a member in the relationship.

NOTE: The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

Returns:

Collection of Graph membership object GraphMemberships

Throws:

AzDException - Default Api exception handler.

list

public GraphMemberships list(String subjectDescriptor,
 Consumer<MembershipsRequestBuilder.RequestConfiguration> requestConfiguration)
                      throws AzDException

Get all the memberships where this descriptor is a member in the relationship.

NOTE: The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

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

Returns:

Collection of Graph membership object GraphMemberships

Throws:

AzDException - Default Api exception handler.

delete

public Void delete(String subjectDescriptor,
 String containerDescriptor)
            throws AzDException

Deletes a membership between a container and subject.

Parameters:

subjectDescriptor - A descriptor to a group or user that can be the child subject in the relationship.

containerDescriptor - A descriptor to a group that can be the container in the relationship.

Throws:

AzDException - Default Api exception handler.