@Generated(value="software.amazon.awssdk:codegen") public final 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.
Modifier and Type | Class and Description |
---|---|
static interface |
JobMetadata.Builder |
Modifier and Type | Method and 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 . |
Instant |
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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.
|
JobState |
jobState()
The current status of the jobs.
|
String |
jobStateAsString()
The current status of the jobs.
|
JobType |
jobType()
The type of job.
|
String |
jobTypeAsString()
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.
|
SnowballCapacity |
snowballCapacityPreference()
The Snowball capacity preference for this job, specified at job creation.
|
String |
snowballCapacityPreferenceAsString()
The Snowball capacity preference for this job, specified at job creation.
|
SnowballType |
snowballType()
The type of appliance used with this job.
|
String |
snowballTypeAsString()
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() |
copy
public String jobId()
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000
.
JID123e4567-e89b-12d3-a456-426655440000
.public JobState jobState()
The current status of the jobs.
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()
.
JobState
public String jobStateAsString()
The current status of the jobs.
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()
.
JobState
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()
.
JobType
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()
.
JobType
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()
.
SnowballType
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()
.
SnowballType
public Instant creationDate()
The creation date for this job.
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.
S3Resource
objects. Each S3Resource
object represents an Amazon S3
bucket that your transferred data will be exported from or imported into.public String description()
The description of the job, provided at job creation.
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.
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).
public String addressId()
The ID for the address that you want the Snowball shipped to.
public ShippingDetails shippingDetails()
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
public SnowballCapacity 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.
If the service returns an enum value that is not available in the current SDK version,
snowballCapacityPreference
will return SnowballCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from snowballCapacityPreferenceAsString()
.
SnowballCapacity
public String snowballCapacityPreferenceAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
snowballCapacityPreference
will return SnowballCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from snowballCapacityPreferenceAsString()
.
SnowballCapacity
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.
Notification
object is returned as a part of the response syntax of the
DescribeJob
action in the JobMetadata
data type.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.
JobState
value of InProgress
, for
both import and export jobs.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.
public String clusterId()
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000
.
CID123e4567-e89b-12d3-a456-426655440000
.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.
public JobMetadata.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<JobMetadata.Builder,JobMetadata>
public static JobMetadata.Builder builder()
public static Class<? extends JobMetadata.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.