Package com.azure.resourcemanager.apimanagement.models

Class GroupCreateParameters

java.lang.Object
com.azure.resourcemanager.apimanagement.models.GroupCreateParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<GroupCreateParameters>
public final class GroupCreateParameters extends Object implements com.azure.json.JsonSerializable<GroupCreateParameters>
Parameters supplied to the Create Group operation.

  • Constructor Details

    • GroupCreateParameters

      public GroupCreateParameters()
      Creates an instance of GroupCreateParameters class.

  • Method Details

    • displayName

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

    • withDisplayName

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

    • description

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

    • withDescription

      public GroupCreateParameters withDescription(String description)
      Set the description property: Group description.
      Parameters:
      description - the description value to set.
      Returns:
      the GroupCreateParameters object itself.

    • type

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

    • withType

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

    • externalId

      public String externalId()
      Get the externalId property: Identifier of the 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 GroupCreateParameters withExternalId(String externalId)
      Set the externalId property: Identifier of the 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 GroupCreateParameters 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<GroupCreateParameters>
      Throws:
      IOException

    • fromJson

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