Share via

GroupContractProperties Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
  • java.lang.Object
    • com.microsoft.azure.management.apimanagement.v2019_01_01.GroupContractProperties

public class GroupContractProperties

Group contract Properties.

Constructor Summary

Constructor Description
GroupContractProperties()

Method Summary

Modifier and Type Method and Description
java.lang.Boolean builtIn()

Get true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
java.lang.String description()

Get group description.
java.lang.String displayName()

Get group name.
java.lang.String externalId()

Get for external groups, this property contains the id of the group from the external identity provider, e.g.
GroupType type()

Get group type.
GroupContractProperties withDescription(String description)

Set group description.
GroupContractProperties withDisplayName(String displayName)

Set group name.
GroupContractProperties withExternalId(String externalId)

Set for external groups, this property contains the id of the group from the external identity provider, e.g.
GroupContractProperties withType(GroupType type)

Set group type.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

GroupContractProperties

public GroupContractProperties()

Method Details

builtIn

public Boolean builtIn()

Get true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

Returns:

the builtIn value

description

public String description()

Get group description. Can contain HTML formatting tags.

Returns:

the description value

displayName

public String displayName()

Get group name.

Returns:

the displayName value

externalId

public String externalId()

Get for external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.

Returns:

the externalId value

type

public GroupType type()

Get group type. Possible values include: 'custom', 'system', 'external'.

Returns:

the type value

withDescription

public GroupContractProperties withDescription(String description)

Set group description. Can contain HTML formatting tags.

Parameters:

description - the description value to set

Returns:

the GroupContractProperties object itself.

withDisplayName

public GroupContractProperties withDisplayName(String displayName)

Set group name.

Parameters:

displayName - the displayName value to set

Returns:

the GroupContractProperties object itself.

withExternalId

public GroupContractProperties withExternalId(String externalId)

Set for external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.

Parameters:

externalId - the externalId value to set

Returns:

the GroupContractProperties object itself.

withType

public GroupContractProperties withType(GroupType type)

Set group type. Possible values include: 'custom', 'system', 'external'.

Parameters:

type - the type value to set

Returns:

the GroupContractProperties object itself.

Applies to