Package com.azure.resourcemanager.apimanagement.models

Class UserEntityBaseParameters

java.lang.Object
com.azure.resourcemanager.apimanagement.models.UserEntityBaseParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<UserEntityBaseParameters>
Direct Known Subclasses:
UserContractProperties, UserCreateParameterProperties, UserUpdateParametersProperties
public class UserEntityBaseParameters extends Object implements com.azure.json.JsonSerializable<UserEntityBaseParameters>
User Entity Base Parameters set.

  • Constructor Details

    • UserEntityBaseParameters

      public UserEntityBaseParameters()
      Creates an instance of UserEntityBaseParameters class.

  • Method Details

    • state

      public UserState state()
      Get the state property: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
      Returns:
      the state value.

    • withState

      public UserEntityBaseParameters withState(UserState state)
      Set the state property: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
      Parameters:
      state - the state value to set.
      Returns:
      the UserEntityBaseParameters object itself.

    • note

      public String note()
      Get the note property: Optional note about a user set by the administrator.
      Returns:
      the note value.

    • withNote

      public UserEntityBaseParameters withNote(String note)
      Set the note property: Optional note about a user set by the administrator.
      Parameters:
      note - the note value to set.
      Returns:
      the UserEntityBaseParameters object itself.

    • identities

      public List<UserIdentityContractInner> identities()
      Get the identities property: Collection of user identities.
      Returns:
      the identities value.

    • withIdentities

      public UserEntityBaseParameters withIdentities(List<UserIdentityContractInner> identities)
      Set the identities property: Collection of user identities.
      Parameters:
      identities - the identities value to set.
      Returns:
      the UserEntityBaseParameters 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<UserEntityBaseParameters>
      Throws:
      IOException

    • fromJson

      public static UserEntityBaseParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of UserEntityBaseParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of UserEntityBaseParameters 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 UserEntityBaseParameters.