com.codedx.client.model

Class User

java.lang.Object

com.codedx.client.model.User

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-12-07T19:30:21.793Z")
public class User
extends java.lang.Object

User

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.TypeEnum Gets or Sets type

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Integer	getId() The user's unique ID
java.lang.String	getName() The user's display name
java.lang.String	getPrincipal() The user's principal.
User.TypeEnum	getType() Get type
int	hashCode()
User	id(java.lang.Integer id)
User	isAdmin(java.lang.Boolean isAdmin)
User	isCurrent(java.lang.Boolean isCurrent)
User	isEnabled(java.lang.Boolean isEnabled)
java.lang.Boolean	isIsAdmin() Flag indicating whether the user has the `admin` role.
java.lang.Boolean	isIsCurrent() Flag indicating whether the user is the same as the one currently logged-in to make the request.
java.lang.Boolean	isIsEnabled() Flag that states whether the user is \"enabled\" (disabled users may not log in, and don't count against your license)
java.lang.Boolean	isIsSystem() Flag indicating whether the user is the Code Dx \"system\" user.
User	isSystem(java.lang.Boolean isSystem)
User	name(java.lang.String name)
User	principal(java.lang.String principal)
void	setId(java.lang.Integer id)
void	setIsAdmin(java.lang.Boolean isAdmin)
void	setIsCurrent(java.lang.Boolean isCurrent)
void	setIsEnabled(java.lang.Boolean isEnabled)
void	setIsSystem(java.lang.Boolean isSystem)
void	setName(java.lang.String name)
void	setPrincipal(java.lang.String principal)
void	setType(User.TypeEnum type)
java.lang.String	toString()
User	type(User.TypeEnum type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

id

public User id(java.lang.Integer id)

getId

public java.lang.Integer getId()

The user's unique ID

Returns:

id

setId

public void setId(java.lang.Integer id)

type

public User type(User.TypeEnum type)

getType

public User.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(User.TypeEnum type)

name

public User name(java.lang.String name)

getName

public java.lang.String getName()

The user's display name

Returns:

name

setName

public void setName(java.lang.String name)

principal

public User principal(java.lang.String principal)

getPrincipal

public java.lang.String getPrincipal()

The user's principal. For `local` and `ldap` users, this will be the same as the name. For `key` users, this will be the API Key

Returns:

principal

setPrincipal

public void setPrincipal(java.lang.String principal)

isEnabled

public User isEnabled(java.lang.Boolean isEnabled)

isIsEnabled

public java.lang.Boolean isIsEnabled()

Flag that states whether the user is \"enabled\" (disabled users may not log in, and don't count against your license)

Returns:

isEnabled

setIsEnabled

public void setIsEnabled(java.lang.Boolean isEnabled)

isSystem

public User isSystem(java.lang.Boolean isSystem)

isIsSystem

public java.lang.Boolean isIsSystem()

Flag indicating whether the user is the Code Dx \"system\" user. This will only be true for the user you set up during installation

Returns:

isSystem

setIsSystem

public void setIsSystem(java.lang.Boolean isSystem)

isAdmin

public User isAdmin(java.lang.Boolean isAdmin)

isIsAdmin

public java.lang.Boolean isIsAdmin()

Flag indicating whether the user has the `admin` role.

Returns:

isAdmin

setIsAdmin

public void setIsAdmin(java.lang.Boolean isAdmin)

isCurrent

public User isCurrent(java.lang.Boolean isCurrent)

isIsCurrent

public java.lang.Boolean isIsCurrent()

Flag indicating whether the user is the same as the one currently logged-in to make the request. In other words, this user is \"you\".

Returns:

isCurrent

setIsCurrent

public void setIsCurrent(java.lang.Boolean isCurrent)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object