​

Method Details

• ​

  getClassSchema

  public static org.apache.avro.Schema getClassSchema()

  This method supports the Avro framework and is not intended to be called directly by the user.

  Returns:

  The schema for the class.

• ​

  getName

  public String getName()

  Name of the user to be created. Must exactly match the user’s name in the external LDAP, prefixed with a @. Must not be the same name as an existing user.

  Returns:

  The current value of name.

• ​

  setName

  public CreateUserExternalRequest setName(String name)

  Name of the user to be created. Must exactly match the user’s name in the external LDAP, prefixed with a @. Must not be the same name as an existing user.

  Parameters:

  name - The new value for name.

  Returns:

  this to mimic the builder pattern.

• ​

  getOptions

  public Map<String,String> getOptions()

  Optional parameters.

  • ACTIVATED: Is the user allowed to login. Supported values:
    • TRUE: User may login.
    • FALSE: User may not login.
    The default value is TRUE.
  • CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values:
    • TRUE
    • FALSE
    The default value is TRUE.
  • DEFAULT_SCHEMA: Default schema to associate with this user.
  • DIRECTORY_DATA_LIMIT: The maximum capacity to apply to the created directory if CREATE_HOME_DIRECTORY is TRUE. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
  • RESOURCE_GROUP: Name of an existing resource group to associate with this user.

  The default value is an empty Map.

  Returns:

  The current value of options.

• ​

  setOptions

  public CreateUserExternalRequest setOptions(Map<String,String> options)

  Optional parameters.

  • ACTIVATED: Is the user allowed to login. Supported values:
    • TRUE: User may login.
    • FALSE: User may not login.
    The default value is TRUE.
  • CREATE_HOME_DIRECTORY: When TRUE, a home directory in KiFS is created for this user. Supported values:
    • TRUE
    • FALSE
    The default value is TRUE.
  • DEFAULT_SCHEMA: Default schema to associate with this user.
  • DIRECTORY_DATA_LIMIT: The maximum capacity to apply to the created directory if CREATE_HOME_DIRECTORY is TRUE. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
  • RESOURCE_GROUP: Name of an existing resource group to associate with this user.

  The default value is an empty Map.

  Parameters:

  options - The new value for options.

  Returns:

  this to mimic the builder pattern.

• ​

  getSchema

  public org.apache.avro.Schema getSchema()

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  getSchema in interface org.apache.avro.generic.GenericContainer

  Returns:

  The schema object describing this class.

• ​

  get

  public Object get(int index)

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  get in interface org.apache.avro.generic.IndexedRecord

  Parameters:

  index - the position of the field to get

  Returns:

  value of the field with the given index.

  Throws:

  IndexOutOfBoundsException

• ​

  put

  public void put(int index, Object value)

  This method supports the Avro framework and is not intended to be called directly by the user.

  Specified by:

  put in interface org.apache.avro.generic.IndexedRecord

  Parameters:

  index - the position of the field to set

  value - the value to set

  Throws:

  IndexOutOfBoundsException

• ​

  equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• ​

  toString

  public String toString()

  Overrides:

  toString in class Object

• ​

  hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object