Package com.azure.resourcemanager.cosmos.fluent.models

Class MongoRoleDefinitionResource

java.lang.Object
com.azure.resourcemanager.cosmos.fluent.models.MongoRoleDefinitionResource
All Implemented Interfaces:
com.azure.json.JsonSerializable<MongoRoleDefinitionResource>
public final class MongoRoleDefinitionResource extends Object implements com.azure.json.JsonSerializable<MongoRoleDefinitionResource>
Azure Cosmos DB Mongo Role Definition resource object.

  • Constructor Details

    • MongoRoleDefinitionResource

      public MongoRoleDefinitionResource()
      Creates an instance of MongoRoleDefinitionResource class.

  • Method Details

    • roleName

      public String roleName()
      Get the roleName property: A user-friendly name for the Role Definition. Must be unique for the database account.
      Returns:
      the roleName value.

    • withRoleName

      public MongoRoleDefinitionResource withRoleName(String roleName)
      Set the roleName property: A user-friendly name for the Role Definition. Must be unique for the database account.
      Parameters:
      roleName - the roleName value to set.
      Returns:
      the MongoRoleDefinitionResource object itself.

    • type

      public MongoRoleDefinitionType type()
      Get the type property: Indicates whether the Role Definition was built-in or user created.
      Returns:
      the type value.

    • withType

      public MongoRoleDefinitionResource withType(MongoRoleDefinitionType type)
      Set the type property: Indicates whether the Role Definition was built-in or user created.
      Parameters:
      type - the type value to set.
      Returns:
      the MongoRoleDefinitionResource object itself.

    • databaseName

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

    • withDatabaseName

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

    • privileges

      public List<Privilege> privileges()
      Get the privileges property: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
      Returns:
      the privileges value.

    • withPrivileges

      public MongoRoleDefinitionResource withPrivileges(List<Privilege> privileges)
      Set the privileges property: A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
      Parameters:
      privileges - the privileges value to set.
      Returns:
      the MongoRoleDefinitionResource object itself.

    • roles

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

    • withRoles

      public MongoRoleDefinitionResource withRoles(List<Role> roles)
      Set the roles property: The set of roles inherited by this Role Definition.
      Parameters:
      roles - the roles value to set.
      Returns:
      the MongoRoleDefinitionResource 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<MongoRoleDefinitionResource>
      Throws:
      IOException

    • fromJson

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