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

Class JobMetadata

java.lang.Object

software.amazon.awssdk.services.snowball.model.JobMetadata

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<JobMetadata.Builder,JobMetadata>

@Generated("software.amazon.awssdk:codegen")
public class JobMetadata
extends Object
implements StructuredPojo, ToCopyableBuilder<JobMetadata.Builder,JobMetadata>

Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobMetadata.Builder

Method Summary

Modifier and Type	Method	Description
String	addressId()	The ID for the address that you want the Snowball shipped to.
static JobMetadata.Builder	builder()
String	clusterId()	The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
Date	creationDate()	The creation date for this job.
DataTransfer	dataTransferProgress()	A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS.
String	description()	The description of the job, provided at job creation.
boolean	equals(Object obj)
String	forwardingAddressId()	The ID of the address that you want a job shipped to, after it will be shipped to its primary address.
int	hashCode()
String	jobId()	The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
JobLogs	jobLogInfo()	Links to Amazon S3 presigned URLs for the job report and logs.
String	jobState()	The current status of the jobs.
String	jobType()	The type of job.
String	kmsKeyARN()	The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Notification	notification()	The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
JobResource	resources()	An array of S3Resource objects.
String	roleARN()	The role ARN associated with this job.
static Class<? extends JobMetadata.Builder>	serializableBuilderClass()
ShippingDetails	shippingDetails()	A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
String	snowballCapacityPreference()	The Snowball capacity preference for this job, specified at job creation.
String	snowballType()	The type of appliance used with this job.
JobMetadata.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

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 String jobState()

The current status of the jobs.

Returns:

The current status of the jobs.

See Also:

JobState

jobType

public String jobType()

The type of job.

Returns:

The type of job.

See Also:

JobType

snowballType

public String snowballType()

The type of appliance used with this job.

Returns:

The type of appliance used with this job.

See Also:

SnowballType

creationDate

public Date creationDate()

The creation date for this job.

Returns:

The creation date for this job.

resources

public JobResource resources()

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

Returns:

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

description

public String description()

The description of the job, provided at job creation.

Returns:

The description of the job, provided at job creation.

kmsKeyARN

public String kmsKeyARN()

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Returns:

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

roleARN

public String roleARN()

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Returns:

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

addressId

public String addressId()

The ID for the address that you want the Snowball shipped to.

Returns:

The ID for the address that you want the Snowball shipped to.

shippingDetails

public ShippingDetails shippingDetails()

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

Returns:

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

snowballCapacityPreference

public String snowballCapacityPreference()

The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

Returns:

The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

See Also:

SnowballCapacity

notification

public Notification notification()

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

Returns:

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

dataTransferProgress

public DataTransfer dataTransferProgress()

A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

Returns:

A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

jobLogInfo

public JobLogs jobLogInfo()

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

Returns:

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

clusterId

public String clusterId()

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Returns:

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

forwardingAddressId

public String forwardingAddressId()

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Returns:

The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

toBuilder

public JobMetadata.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<JobMetadata.Builder,JobMetadata>

Returns:

a builder for type T

builder

public static JobMetadata.Builder builder()

serializableBuilderClass

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

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.