software.amazon.awssdk.services.snowball.model

Class JobListEntry

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<JobListEntry.Builder,JobListEntry>

@Generated(value="software.amazon.awssdk:codegen")
public class JobListEntry
extends Object
implements StructuredPojo, 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobListEntry.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isMaster() A value that indicates that this job is a master 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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends JobListEntry.Builder>	serializableBuilderClass()
SnowballType	snowballType() The type of appliance used with this job.
String	snowballTypeAsString() The type of appliance used with this job.
JobListEntry.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobId

public 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 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 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 Boolean isMaster()

A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master 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 master job are listed, because they are created after the master job is created.

Returns:

A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master 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 master job are listed, because they are created after the master job is created.

jobType

public 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 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 SnowballType snowballType()

The type of appliance 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 appliance used with this job.

See Also:

SnowballType

snowballTypeAsString

public String snowballTypeAsString()

The type of appliance 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 appliance used with this job.

See Also:

SnowballType

creationDate

public Instant creationDate()

The creation date for this job.

Returns:

The creation date for this job.

description

public 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<JobListEntry.Builder,JobListEntry>

Returns:

a builder for type T

builder

public static JobListEntry.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.