Package com.azure.resourcemanager.apimanagement.fluent.models

Class GroupContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.fluent.models.GroupContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<GroupContractProperties>
public final class GroupContractProperties extends Object implements com.azure.json.JsonSerializable<GroupContractProperties>
Group contract Properties.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GroupContractProperties()
    Creates an instance of GroupContractProperties class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    builtIn()
    Get the builtIn property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
    String
    description()
    Get the description property: Group description.
    String
    displayName()
    Get the displayName property: Group name.
    String
    externalId()
    Get the externalId property: 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.
    static GroupContractProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of GroupContractProperties from the JsonReader.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    GroupType
    type()
    Get the type property: Group type.
    void
    validate()
    Validates the instance.
    GroupContractProperties
    withDescription(String description)
    Set the description property: Group description.
    GroupContractProperties
    withDisplayName(String displayName)
    Set the displayName property: Group name.
    GroupContractProperties
    withExternalId(String externalId)
    Set the externalId property: 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.
    GroupContractProperties
    withType(GroupType type)
    Set the type property: Group type.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • GroupContractProperties

      public GroupContractProperties()
      Creates an instance of GroupContractProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: Group name.
      Returns:
      the displayName value.

    • withDisplayName

      public GroupContractProperties withDisplayName(String displayName)
      Set the displayName property: Group name.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the GroupContractProperties object itself.

    • description

      public String description()
      Get the description property: Group description. Can contain HTML formatting tags.
      Returns:
      the description value.

    • withDescription

      public GroupContractProperties withDescription(String description)
      Set the description property: Group description. Can contain HTML formatting tags.
      Parameters:
      description - the description value to set.
      Returns:
      the GroupContractProperties object itself.

    • builtIn

      public Boolean builtIn()
      Get the builtIn property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
      Returns:
      the builtIn value.

    • type

      public GroupType type()
      Get the type property: Group type.
      Returns:
      the type value.

    • withType

      public GroupContractProperties withType(GroupType type)
      Set the type property: Group type.
      Parameters:
      type - the type value to set.
      Returns:
      the GroupContractProperties object itself.

    • externalId

      public String externalId()
      Get the externalId property: 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.

    • withExternalId

      public GroupContractProperties withExternalId(String externalId)
      Set the externalId property: 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.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<GroupContractProperties>
      Throws:
      IOException

    • fromJson

      public static GroupContractProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of GroupContractProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of GroupContractProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the GroupContractProperties.