ImmutableO365PurgeUserResponse (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.core.web.rest.response.vbo.ImmutableO365PurgeUserResponse

All Implemented Interfaces:: O365PurgeUserResponse

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

Immutable implementation of O365PurgeUserResponse.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableO365PurgeUserResponse.Builder
Builds instances of type ImmutableO365PurgeUserResponse.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`active()` Whether this user / mailbox will be purged at all (cancel use case).
`static ImmutableO365PurgeUserResponse.Builder`	`builder()` Creates a builder for `ImmutableO365PurgeUserResponse`.
`Optional<Instant>`	`completedDate()` Specifies the purge completed date time.
`static ImmutableO365PurgeUserResponse`	`copyOf(O365PurgeUserResponse instance)` Creates an immutable copy of a `O365PurgeUserResponse` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableO365PurgeUserResponse` that have equal attribute values.
`Optional<String>`	`errorMsg()` The error message if any on this purge request (would come from monocle)
`int`	`hashCode()` Computes a hash code from attributes: `userNativeUuid`, `mailbox`, `organizationUuid`, `initiatedDate`, `purgeDate`, `active`, `purgeStatus`, `errorMsg`, `requestedBy`, `completedDate`.
`Instant`	`initiatedDate()` Get the purge initiated date associated with this mailbox.
`String`	`mailbox()` The mailbox (email) that is marked for purging.
`String`	`organizationUuid()` Get the org platform uuid associated with this mailbox.
`Instant`	`purgeDate()` Get the purge date associated with this mailbox.
`String`	`purgeStatus()` The status of this purge user request - Completed, Running, Cancelled or Failed
`Optional<String>`	`requestedBy()` The admin user who requested purging of this user.
`String`	`toString()` Prints the immutable value `O365PurgeUserResponse` with attribute values.
`String`	`userNativeUuid()` The user native uuid for the mailbox that was marked for purging.
`ImmutableO365PurgeUserResponse`	`withActive(boolean value)` Copy the current immutable object by setting a value for the `active` attribute.
`ImmutableO365PurgeUserResponse`	`withCompletedDate(Instant value)` Copy the current immutable object by setting a present value for the optional `completedDate` attribute.
`ImmutableO365PurgeUserResponse`	`withCompletedDate(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `completedDate` attribute.
`ImmutableO365PurgeUserResponse`	`withErrorMsg(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `errorMsg` attribute.
`ImmutableO365PurgeUserResponse`	`withErrorMsg(String value)` Copy the current immutable object by setting a present value for the optional `errorMsg` attribute.
`ImmutableO365PurgeUserResponse`	`withInitiatedDate(Instant value)` Copy the current immutable object by setting a value for the `initiatedDate` attribute.
`ImmutableO365PurgeUserResponse`	`withMailbox(String value)` Copy the current immutable object by setting a value for the `mailbox` attribute.
`ImmutableO365PurgeUserResponse`	`withOrganizationUuid(String value)` Copy the current immutable object by setting a value for the `organizationUuid` attribute.
`ImmutableO365PurgeUserResponse`	`withPurgeDate(Instant value)` Copy the current immutable object by setting a value for the `purgeDate` attribute.
`ImmutableO365PurgeUserResponse`	`withPurgeStatus(String value)` Copy the current immutable object by setting a value for the `purgeStatus` attribute.
`ImmutableO365PurgeUserResponse`	`withRequestedBy(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `requestedBy` attribute.
`ImmutableO365PurgeUserResponse`	`withRequestedBy(String value)` Copy the current immutable object by setting a present value for the optional `requestedBy` attribute.
`ImmutableO365PurgeUserResponse`	`withUserNativeUuid(String value)` Copy the current immutable object by setting a value for the `userNativeUuid` attribute.

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

- Method Detail
  - userNativeUuid
```
public String userNativeUuid()
```
    The user native uuid for the mailbox that was marked for purging.
    
    Specified by:
    
    userNativeUuid in interface O365PurgeUserResponse
  - mailbox
```
public String mailbox()
```
    The mailbox (email) that is marked for purging.
    
    Specified by:
    
    mailbox in interface O365PurgeUserResponse
  - organizationUuid
```
public String organizationUuid()
```
    Get the org platform uuid associated with this mailbox.
    
    Specified by:
    
    organizationUuid in interface O365PurgeUserResponse
  - initiatedDate
```
public Instant initiatedDate()
```
    Get the purge initiated date associated with this mailbox.
    
    Specified by:
    
    initiatedDate in interface O365PurgeUserResponse
  - purgeDate
```
public Instant purgeDate()
```
    Get the purge date associated with this mailbox.
    
    Specified by:
    
    purgeDate in interface O365PurgeUserResponse
  - active
```
public boolean active()
```
    Whether this user / mailbox will be purged at all (cancel use case).
    
    Specified by:
    
    active in interface O365PurgeUserResponse
  - purgeStatus
```
public String purgeStatus()
```
    The status of this purge user request - Completed, Running, Cancelled or Failed
    
    Specified by:
    
    purgeStatus in interface O365PurgeUserResponse
  - errorMsg
```
public Optional<String> errorMsg()
```
    The error message if any on this purge request (would come from monocle)
    
    Specified by:
    
    errorMsg in interface O365PurgeUserResponse
  - requestedBy
```
public Optional<String> requestedBy()
```
    The admin user who requested purging of this user.
    
    Specified by:
    
    requestedBy in interface O365PurgeUserResponse
  - completedDate
```
public Optional<Instant> completedDate()
```
    Specifies the purge completed date time.
    
    Specified by:
    
    completedDate in interface O365PurgeUserResponse
  - withUserNativeUuid
```
public final ImmutableO365PurgeUserResponse withUserNativeUuid(String value)
```
    Copy the current immutable object by setting a value for the userNativeUuid attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for userNativeUuid
    
    Returns:
    
    A modified copy of the this object
  - withMailbox
```
public final ImmutableO365PurgeUserResponse withMailbox(String value)
```
    Copy the current immutable object by setting a value for the mailbox attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for mailbox
    
    Returns:
    
    A modified copy of the this object
  - withOrganizationUuid
```
public final ImmutableO365PurgeUserResponse withOrganizationUuid(String value)
```
    Copy the current immutable object by setting a value for the organizationUuid attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for organizationUuid
    
    Returns:
    
    A modified copy of the this object
  - withInitiatedDate
```
public final ImmutableO365PurgeUserResponse withInitiatedDate(Instant value)
```
    Copy the current immutable object by setting a value for the initiatedDate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for initiatedDate
    
    Returns:
    
    A modified copy of the this object
  - withPurgeDate
```
public final ImmutableO365PurgeUserResponse withPurgeDate(Instant value)
```
    Copy the current immutable object by setting a value for the purgeDate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for purgeDate
    
    Returns:
    
    A modified copy of the this object
  - withActive
```
public final ImmutableO365PurgeUserResponse withActive(boolean value)
```
    Copy the current immutable object by setting a value for the active attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for active
    
    Returns:
    
    A modified copy of the this object
  - withPurgeStatus
```
public final ImmutableO365PurgeUserResponse withPurgeStatus(String value)
```
    Copy the current immutable object by setting a value for the purgeStatus attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for purgeStatus
    
    Returns:
    
    A modified copy of the this object
  - withErrorMsg
```
public final ImmutableO365PurgeUserResponse withErrorMsg(String value)
```
    Copy the current immutable object by setting a present value for the optional errorMsg attribute.
    
    Parameters:
    
    value - The value for errorMsg
    
    Returns:
    
    A modified copy of this object
  - withErrorMsg
```
public final ImmutableO365PurgeUserResponse withErrorMsg(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the errorMsg 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 errorMsg
    
    Returns:
    
    A modified copy of this object
  - withRequestedBy
```
public final ImmutableO365PurgeUserResponse withRequestedBy(String value)
```
    Copy the current immutable object by setting a present value for the optional requestedBy attribute.
    
    Parameters:
    
    value - The value for requestedBy
    
    Returns:
    
    A modified copy of this object
  - withRequestedBy
```
public final ImmutableO365PurgeUserResponse withRequestedBy(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the requestedBy 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 requestedBy
    
    Returns:
    
    A modified copy of this object
  - withCompletedDate
```
public final ImmutableO365PurgeUserResponse withCompletedDate(Instant value)
```
    Copy the current immutable object by setting a present value for the optional completedDate attribute.
    
    Parameters:
    
    value - The value for completedDate
    
    Returns:
    
    A modified copy of this object
  - withCompletedDate
```
public final ImmutableO365PurgeUserResponse withCompletedDate(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the completedDate attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for completedDate
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableO365PurgeUserResponse 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: userNativeUuid, mailbox, organizationUuid, initiatedDate, purgeDate, active, purgeStatus, errorMsg, requestedBy, completedDate.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value O365PurgeUserResponse with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableO365PurgeUserResponse copyOf(O365PurgeUserResponse instance)
```
    Creates an immutable copy of a O365PurgeUserResponse 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 O365PurgeUserResponse instance
  - builder
```
public static ImmutableO365PurgeUserResponse.Builder builder()
```
    Creates a builder for ImmutableO365PurgeUserResponse.
```
 ImmutableO365PurgeUserResponse.builder()
    .userNativeUuid(String) // required userNativeUuid
    .mailbox(String) // required mailbox
    .organizationUuid(String) // required organizationUuid
    .initiatedDate(java.time.Instant) // required initiatedDate
    .purgeDate(java.time.Instant) // required purgeDate
    .active(boolean) // required active
    .purgeStatus(String) // required purgeStatus
    .errorMsg(String) // optional errorMsg
    .requestedBy(String) // optional requestedBy
    .completedDate(java.time.Instant) // optional completedDate
    .build();
 
```
    Returns:
    
    A new ImmutableO365PurgeUserResponse builder

Class ImmutableO365PurgeUserResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

userNativeUuid

mailbox

organizationUuid

initiatedDate

purgeDate

active

purgeStatus

errorMsg

requestedBy

completedDate

withUserNativeUuid

withMailbox

withOrganizationUuid

withInitiatedDate

withPurgeDate

withActive

withPurgeStatus

withErrorMsg

withErrorMsg

withRequestedBy

withRequestedBy

withCompletedDate

withCompletedDate

equals

hashCode

toString

copyOf

builder