ImmutableUserCreateRequest (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.core.web.rest.request.user.ImmutableUserCreateRequest

All Implemented Interfaces:: UserCreateRequest

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
public final class ImmutableUserCreateRequest
extends Object
implements UserCreateRequest

Immutable implementation of UserCreateRequest.

Use the builder to create immutable instances: ImmutableUserCreateRequest.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableUserCreateRequest.Builder
Builds instances of type ImmutableUserCreateRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableUserCreateRequest.Builder` Builds instances of type `ImmutableUserCreateRequest`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableUserCreateRequest.Builder`	`builder()` Creates a builder for `ImmutableUserCreateRequest`.
`static ImmutableUserCreateRequest`	`copyOf(UserCreateRequest instance)` Creates an immutable copy of a `UserCreateRequest` value.
`String`	`domain()` Get the domain that the user should be created in.
`String`	`email()` Get the email.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableUserCreateRequest` that have equal attribute values.
`String`	`fullname()` Get the user's full name.
`int`	`hashCode()` Computes a hash code from attributes: `domain`, `fullname`, `username`, `email`, `roleUuid`, `sendInvitation`, `password`.
`Optional<String>`	`password()` Password of the newly created user.
`Optional<String>`	`roleUuid()` Get the role the user should belong to.
`Optional<Boolean>`	`sendInvitation()` Whether to send an email invitation when creating a user.
`String`	`toString()` Prints the immutable value `UserCreateRequest` with attribute values.
`String`	`username()` Get the username.
`ImmutableUserCreateRequest`	`withDomain(String value)` Copy the current immutable object by setting a value for the `domain` attribute.
`ImmutableUserCreateRequest`	`withEmail(String value)` Copy the current immutable object by setting a value for the `email` attribute.
`ImmutableUserCreateRequest`	`withFullname(String value)` Copy the current immutable object by setting a value for the `fullname` attribute.
`ImmutableUserCreateRequest`	`withPassword(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `password` attribute.
`ImmutableUserCreateRequest`	`withPassword(String value)` Copy the current immutable object by setting a present value for the optional `password` attribute.
`ImmutableUserCreateRequest`	`withRoleUuid(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `roleUuid` attribute.
`ImmutableUserCreateRequest`	`withRoleUuid(String value)` Copy the current immutable object by setting a present value for the optional `roleUuid` attribute.
`ImmutableUserCreateRequest`	`withSendInvitation(boolean value)` Copy the current immutable object by setting a present value for the optional `sendInvitation` attribute.
`ImmutableUserCreateRequest`	`withSendInvitation(Optional<Boolean> optional)` Copy the current immutable object by setting an optional value for the `sendInvitation` attribute.
`ImmutableUserCreateRequest`	`withUsername(String value)` Copy the current immutable object by setting a value for the `username` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - domain
```
public String domain()
```
    Get the domain that the user should be created in.
    
    Specified by:
    
    domain in interface UserCreateRequest
    
    Returns:
    
    String domain
  - fullname
```
public String fullname()
```
    Get the user's full name.
    
    Specified by:
    
    fullname in interface UserCreateRequest
    
    Returns:
    
    String full name
  - username
```
public String username()
```
    Get the username.
    
    Specified by:
    
    username in interface UserCreateRequest
    
    Returns:
    
    String username
  - email
```
public String email()
```
    Get the email.
    
    Specified by:
    
    email in interface UserCreateRequest
    
    Returns:
    
    String email
  - roleUuid
```
public Optional<String> roleUuid()
```
    Get the role the user should belong to.
    
    Specified by:
    
    roleUuid in interface UserCreateRequest
    
    Returns:
    
    Optional of String role uuid
  - sendInvitation
```
public Optional<Boolean> sendInvitation()
```
    Whether to send an email invitation when creating a user.
    
    Specified by:
    
    sendInvitation in interface UserCreateRequest
    
    Returns:
    
    whether to send an email invention
  - password
```
public Optional<String> password()
```
    Password of the newly created user. If this field is not passed then the user has to set their password upon first login.
    
    Specified by:
    
    password in interface UserCreateRequest
  - withDomain
```
public final ImmutableUserCreateRequest withDomain(String value)
```
    Copy the current immutable object by setting a value for the domain attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for domain
    
    Returns:
    
    A modified copy of the this object
  - withFullname
```
public final ImmutableUserCreateRequest withFullname(String value)
```
    Copy the current immutable object by setting a value for the fullname attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fullname
    
    Returns:
    
    A modified copy of the this object
  - withUsername
```
public final ImmutableUserCreateRequest withUsername(String value)
```
    Copy the current immutable object by setting a value for the username attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for username
    
    Returns:
    
    A modified copy of the this object
  - withEmail
```
public final ImmutableUserCreateRequest withEmail(String value)
```
    Copy the current immutable object by setting a value for the email attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for email
    
    Returns:
    
    A modified copy of the this object
  - withRoleUuid
```
public final ImmutableUserCreateRequest withRoleUuid(String value)
```
    Copy the current immutable object by setting a present value for the optional roleUuid attribute.
    
    Parameters:
    
    value - The value for roleUuid
    
    Returns:
    
    A modified copy of this object
  - withRoleUuid
```
public final ImmutableUserCreateRequest withRoleUuid(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the roleUuid attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for roleUuid
    
    Returns:
    
    A modified copy of this object
  - withSendInvitation
```
public final ImmutableUserCreateRequest withSendInvitation(boolean value)
```
    Copy the current immutable object by setting a present value for the optional sendInvitation attribute.
    
    Parameters:
    
    value - The value for sendInvitation
    
    Returns:
    
    A modified copy of this object
  - withSendInvitation
```
public final ImmutableUserCreateRequest withSendInvitation(Optional<Boolean> optional)
```
    Copy the current immutable object by setting an optional value for the sendInvitation attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for sendInvitation
    
    Returns:
    
    A modified copy of this object
  - withPassword
```
public final ImmutableUserCreateRequest withPassword(String value)
```
    Copy the current immutable object by setting a present value for the optional password attribute.
    
    Parameters:
    
    value - The value for password
    
    Returns:
    
    A modified copy of this object
  - withPassword
```
public final ImmutableUserCreateRequest withPassword(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the password attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for password
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableUserCreateRequest that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: domain, fullname, username, email, roleUuid, sendInvitation, password.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value UserCreateRequest with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableUserCreateRequest copyOf(UserCreateRequest instance)
```
    Creates an immutable copy of a UserCreateRequest value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable UserCreateRequest instance
  - builder
```
public static ImmutableUserCreateRequest.Builder builder()
```
    Creates a builder for ImmutableUserCreateRequest.
```
 ImmutableUserCreateRequest.builder()
    .domain(String) // required domain
    .fullname(String) // required fullname
    .username(String) // required username
    .email(String) // required email
    .roleUuid(String) // optional roleUuid
    .sendInvitation(Boolean) // optional sendInvitation
    .password(String) // optional password
    .build();
 
```
    Returns:
    
    A new ImmutableUserCreateRequest builder

Class ImmutableUserCreateRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

domain

fullname

username

email

roleUuid

sendInvitation

password

withDomain

withFullname

withUsername

withEmail

withRoleUuid

withRoleUuid

withSendInvitation

withSendInvitation

withPassword

withPassword

equals

hashCode

toString

copyOf

builder