Package software.amazon.awssdk.services.snowball.model

Class JobListEntry

java.lang.Object

software.amazon.awssdk.services.snowball.model.JobListEntry

All Implemented Interfaces:

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

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

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of an export job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobListEntry.Builder

Method Summary

Modifier and Type	Method	Description
static JobListEntry.Builder	builder()
Instant	creationDate()	The creation date for this job.
String	description()	The optional description of this specific job, for example Important Photos 2016-08-11.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isMaster()	A value that indicates that this job is a main job.
String	jobId()	The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
JobState	jobState()	The current state of this job.
String	jobStateAsString()	The current state of this job.
JobType	jobType()	The type of job.
String	jobTypeAsString()	The type of job.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends JobListEntry.Builder>	serializableBuilderClass()
SnowballType	snowballType()	The type of device used with this job.
String	snowballTypeAsString()	The type of device used with this job.
JobListEntry.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 automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Returns:

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

jobState

public final JobState jobState()

The current state of this job.

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

Returns:

The current state of this job.

See Also:

JobState

jobStateAsString

public final String jobStateAsString()

The current state of this job.

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

Returns:

The current state of this job.

See Also:

JobState

isMaster

public final Boolean isMaster()

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

Returns:

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

jobType

public final JobType jobType()

The type of job.

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

Returns:

The type of job.

See Also:

JobType

jobTypeAsString

public final String jobTypeAsString()

The type of job.

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

Returns:

The type of job.

See Also:

JobType

snowballType

public final SnowballType snowballType()

The type of device used with this job.

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

Returns:

The type of device used with this job.

See Also:

SnowballType

snowballTypeAsString

public final String snowballTypeAsString()

The type of device used with this job.

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

Returns:

The type of device used with this job.

See Also:

SnowballType

creationDate

public final Instant creationDate()

The creation date for this job.

Returns:

The creation date for this job.

description

public final String description()

The optional description of this specific job, for example Important Photos 2016-08-11.

Returns:

The optional description of this specific job, for example Important Photos 2016-08-11.

toBuilder

public JobListEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobListEntry.Builder,JobListEntry>

builder

public static JobListEntry.Builder builder()

serializableBuilderClass

public static Class<? extends JobListEntry.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo