Package software.amazon.awssdk.services.workmail.model

Class MailboxExportJob

java.lang.Object

software.amazon.awssdk.services.workmail.model.MailboxExportJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MailboxExportJob.Builder,MailboxExportJob>

@Generated("software.amazon.awssdk:codegen")
public final class MailboxExportJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MailboxExportJob.Builder,MailboxExportJob>

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MailboxExportJob.Builder

Method Summary

Modifier and Type	Method	Description
static MailboxExportJob.Builder	builder()
String	description()	The mailbox export job description.
Instant	endTime()	The mailbox export job end timestamp.
String	entityId()	The identifier of the user or resource associated with the mailbox.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	estimatedProgress()	The estimated progress of the mailbox export job, in percentage points.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The identifier of the mailbox export job.
String	s3BucketName()	The name of the S3 bucket.
String	s3Path()	The path to the S3 bucket and file that the mailbox export job exports to.
List<SdkField<?>>	sdkFields()
static Class<? extends MailboxExportJob.Builder>	serializableBuilderClass()
Instant	startTime()	The mailbox export job start timestamp.
MailboxExportJobState	state()	The state of the mailbox export job.
String	stateAsString()	The state of the mailbox export job.
MailboxExportJob.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobId

public final String jobId()

The identifier of the mailbox export job.

Returns:

The identifier of the mailbox export job.

entityId

public final String entityId()

The identifier of the user or resource associated with the mailbox.

Returns:

The identifier of the user or resource associated with the mailbox.

description

public final String description()

The mailbox export job description.

Returns:

The mailbox export job description.

s3BucketName

public final String s3BucketName()

The name of the S3 bucket.

Returns:

The name of the S3 bucket.

s3Path

public final String s3Path()

The path to the S3 bucket and file that the mailbox export job exports to.

Returns:

The path to the S3 bucket and file that the mailbox export job exports to.

estimatedProgress

public final Integer estimatedProgress()

The estimated progress of the mailbox export job, in percentage points.

Returns:

The estimated progress of the mailbox export job, in percentage points.

state

public final MailboxExportJobState state()

The state of the mailbox export job.

If the service returns an enum value that is not available in the current SDK version, state will return MailboxExportJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the mailbox export job.

See Also:

MailboxExportJobState

stateAsString

public final String stateAsString()

The state of the mailbox export job.

If the service returns an enum value that is not available in the current SDK version, state will return MailboxExportJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the mailbox export job.

See Also:

MailboxExportJobState

startTime

public final Instant startTime()

The mailbox export job start timestamp.

Returns:

The mailbox export job start timestamp.

endTime

public final Instant endTime()

The mailbox export job end timestamp.

Returns:

The mailbox export job end timestamp.

toBuilder

public MailboxExportJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MailboxExportJob.Builder,MailboxExportJob>

builder

public static MailboxExportJob.Builder builder()

serializableBuilderClass

public static Class<? extends MailboxExportJob.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo