Class MongoUserDefinitionCreateUpdateParameters

java.lang.Object
com.azure.resourcemanager.cosmos.models.MongoUserDefinitionCreateUpdateParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<MongoUserDefinitionCreateUpdateParameters>

public final class MongoUserDefinitionCreateUpdateParameters extends Object implements com.azure.json.JsonSerializable<MongoUserDefinitionCreateUpdateParameters>
Parameters to create and update an Azure Cosmos DB Mongo User Definition.
  • Constructor Details

    • MongoUserDefinitionCreateUpdateParameters

      public MongoUserDefinitionCreateUpdateParameters()
      Creates an instance of MongoUserDefinitionCreateUpdateParameters class.
  • Method Details

    • username

      public String username()
      Get the username property: The user name for User Definition.
      Returns:
      the username value.
    • withUsername

      public MongoUserDefinitionCreateUpdateParameters withUsername(String username)
      Set the username property: The user name for User Definition.
      Parameters:
      username - the username value to set.
      Returns:
      the MongoUserDefinitionCreateUpdateParameters object itself.
    • password

      public String password()
      Get the password property: The password for User Definition. Response does not contain user password.
      Returns:
      the password value.
    • withPassword

      public MongoUserDefinitionCreateUpdateParameters withPassword(String password)
      Set the password property: The password for User Definition. Response does not contain user password.
      Parameters:
      password - the password value to set.
      Returns:
      the MongoUserDefinitionCreateUpdateParameters object itself.
    • databaseName

      public String databaseName()
      Get the databaseName property: The database name for which access is being granted for this User Definition.
      Returns:
      the databaseName value.
    • withDatabaseName

      public MongoUserDefinitionCreateUpdateParameters withDatabaseName(String databaseName)
      Set the databaseName property: The database name for which access is being granted for this User Definition.
      Parameters:
      databaseName - the databaseName value to set.
      Returns:
      the MongoUserDefinitionCreateUpdateParameters object itself.
    • customData

      public String customData()
      Get the customData property: A custom definition for the USer Definition.
      Returns:
      the customData value.
    • withCustomData

      public MongoUserDefinitionCreateUpdateParameters withCustomData(String customData)
      Set the customData property: A custom definition for the USer Definition.
      Parameters:
      customData - the customData value to set.
      Returns:
      the MongoUserDefinitionCreateUpdateParameters object itself.
    • roles

      public List<Role> roles()
      Get the roles property: The set of roles inherited by the User Definition.
      Returns:
      the roles value.
    • withRoles

      Set the roles property: The set of roles inherited by the User Definition.
      Parameters:
      roles - the roles value to set.
      Returns:
      the MongoUserDefinitionCreateUpdateParameters object itself.
    • mechanisms

      public String mechanisms()
      Get the mechanisms property: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
      Returns:
      the mechanisms value.
    • withMechanisms

      public MongoUserDefinitionCreateUpdateParameters withMechanisms(String mechanisms)
      Set the mechanisms property: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
      Parameters:
      mechanisms - the mechanisms value to set.
      Returns:
      the MongoUserDefinitionCreateUpdateParameters 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<MongoUserDefinitionCreateUpdateParameters>
      Throws:
      IOException
    • fromJson

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