Package org.azd.memberentitlementmanagement.groupentitlements

Class GroupEntitlementsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.memberentitlementmanagement.groupentitlements.GroupEntitlementsRequestBuilder

public class GroupEntitlementsRequestBuilder
extends BaseRequestBuilder

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

Method Summary

Modifier and Type	Method	Description
GroupEntitlementOperationReference	add(GroupEntitlement groupEntitlement)	Create a group entitlement with license rule, extension rule.
GroupEntitlementOperationReference	add(GroupEntitlement groupEntitlement, RuleOption ruleOption)	Create a group entitlement with license rule, extension rule.
CompletableFuture<GroupEntitlementOperationReference>	addAsync(GroupEntitlement groupEntitlement)	Create a group entitlement with license rule, extension rule.
CompletableFuture<GroupEntitlementOperationReference>	addAsync(GroupEntitlement groupEntitlement, RuleOption ruleOption)	Create a group entitlement with license rule, extension rule.
Void	delete(String groupId)	Delete a group entitlement.
Void	delete(String groupId, RuleOption ruleOption)	Delete a group entitlement.
CompletableFuture<Void>	deleteAsync(String groupId)	Delete a group entitlement.
CompletableFuture<Void>	deleteAsync(String groupId, RuleOption ruleOption)	Delete a group entitlement.
GroupEntitlement	get(String groupId)	Get a group entitlement.
CompletableFuture<GroupEntitlement>	getAsync(String groupId)	Get a group entitlement.
GroupEntitlements	list()	Get the group entitlements for an account.
CompletableFuture<GroupEntitlements>	listAsync()	Get the group entitlements for an account.
GroupEntitlementOperationReference	update(JsonPatchDocument jsonPatchDocument, String groupId)	Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.
GroupEntitlementOperationReference	update(JsonPatchDocument jsonPatchDocument, String groupId, RuleOption ruleOption)	Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.
CompletableFuture<GroupEntitlementOperationReference>	updateAsync(JsonPatchDocument jsonPatchDocument, String groupId)	Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.
CompletableFuture<GroupEntitlementOperationReference>	updateAsync(JsonPatchDocument jsonPatchDocument, String groupId, RuleOption ruleOption)	Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a 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

GroupEntitlementsRequestBuilder

public GroupEntitlementsRequestBuilder(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<GroupEntitlementOperationReference> addAsync(GroupEntitlement groupEntitlement)
                                                               throws AzDException

Create a group entitlement with license rule, extension rule.

Parameters:

groupEntitlement - Group entitlement object to add.

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

addAsync

public CompletableFuture<GroupEntitlementOperationReference> addAsync(GroupEntitlement groupEntitlement,
 RuleOption ruleOption)
                                                               throws AzDException

Create a group entitlement with license rule, extension rule.

Parameters:

groupEntitlement - Group entitlement object to add.

ruleOption - RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String groupId)
                                    throws AzDException

Delete a group entitlement.

Parameters:

groupId - ID of the group to delete.

Throws:

AzDException - Default Api request handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String groupId,
 RuleOption ruleOption)
                                    throws AzDException

Delete a group entitlement.

Parameters:

groupId - ID of the group to delete.

ruleOption - RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested

Throws:

AzDException - Default Api request handler.

getAsync

public CompletableFuture<GroupEntitlement> getAsync(String groupId)
                                             throws AzDException

Get a group entitlement. If the group entitlement does not exist, returns null.

Parameters:

groupId - ID of the group.

Returns:

Group entitlement object GroupEntitlement

Throws:

AzDException - Default Api request handler.

listAsync

public CompletableFuture<GroupEntitlements> listAsync()
                                               throws AzDException

Get the group entitlements for an account.

Returns:

Collection of Group entitlement object GroupEntitlements

Throws:

AzDException - Default Api request handler.

updateAsync

public CompletableFuture<GroupEntitlementOperationReference> updateAsync(JsonPatchDocument jsonPatchDocument,
 String groupId)
                                                                  throws AzDException

Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.

Parameters:

jsonPatchDocument - Request body to update the group entitlement.

groupId - ID of the group.

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

updateAsync

public CompletableFuture<GroupEntitlementOperationReference> updateAsync(JsonPatchDocument jsonPatchDocument,
 String groupId,
 RuleOption ruleOption)
                                                                  throws AzDException

Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.

Parameters:

jsonPatchDocument - Request body to update the group entitlement.

groupId - ID of the group.

ruleOption - RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

add

public GroupEntitlementOperationReference add(GroupEntitlement groupEntitlement)
                                       throws AzDException

Create a group entitlement with license rule, extension rule.

Parameters:

groupEntitlement - Group entitlement object to add.

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

add

public GroupEntitlementOperationReference add(GroupEntitlement groupEntitlement,
 RuleOption ruleOption)
                                       throws AzDException

Create a group entitlement with license rule, extension rule.

Parameters:

groupEntitlement - Group entitlement object to add.

ruleOption - RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

delete

public Void delete(String groupId)
            throws AzDException

Delete a group entitlement.

Parameters:

groupId - ID of the group to delete.

Throws:

AzDException - Default Api request handler.

delete

public Void delete(String groupId,
 RuleOption ruleOption)
            throws AzDException

Delete a group entitlement.

Parameters:

groupId - ID of the group to delete.

ruleOption - RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested

Throws:

AzDException - Default Api request handler.

get

public GroupEntitlement get(String groupId)
                     throws AzDException

Get a group entitlement. If the group entitlement does not exist, returns null.

Parameters:

groupId - ID of the group.

Returns:

Group entitlement object GroupEntitlement

Throws:

AzDException - Default Api request handler.

list

public GroupEntitlements list()
                       throws AzDException

Get the group entitlements for an account.

Returns:

Collection of Group entitlement object GroupEntitlements

Throws:

AzDException - Default Api request handler.

update

public GroupEntitlementOperationReference update(JsonPatchDocument jsonPatchDocument,
 String groupId)
                                          throws AzDException

Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.

Parameters:

jsonPatchDocument - Request body to update the group entitlement.

groupId - ID of the group.

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.

update

public GroupEntitlementOperationReference update(JsonPatchDocument jsonPatchDocument,
 String groupId,
 RuleOption ruleOption)
                                          throws AzDException

Update entitlements (License Rule, Extensions Rule, Project memberships etc.) for a group.

Parameters:

jsonPatchDocument - Request body to update the group entitlement.

groupId - ID of the group.

ruleOption - RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested

Returns:

Operation reference of the group entitlement.

Throws:

AzDException - Default Api request handler.