@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class JobMetadata extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
JobMetadata() |
Modifier and Type | Method and Description |
---|---|
JobMetadata |
clone() |
boolean |
equals(Object obj) |
String |
getAddressId()
The ID for the address that you want the Snowball shipped to.
|
String |
getClusterId()
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000 . |
Date |
getCreationDate()
The creation date for this job.
|
DataTransfer |
getDataTransferProgress()
A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS.
|
String |
getDescription()
The description of the job, provided at job creation.
|
String |
getForwardingAddressId()
The ID of the address that you want a job shipped to, after it will be shipped to its primary address.
|
String |
getJobId()
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000 . |
JobLogs |
getJobLogInfo()
Links to Amazon S3 presigned URLs for the job report and logs.
|
String |
getJobState()
The current status of the jobs.
|
String |
getJobType()
The type of job.
|
String |
getKmsKeyARN()
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job.
|
Notification |
getNotification()
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
|
JobResource |
getResources()
An array of
S3Resource objects. |
String |
getRoleARN()
The role ARN associated with this job.
|
ShippingDetails |
getShippingDetails()
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
|
String |
getSnowballCapacityPreference()
The Snowball capacity preference for this job, specified at job creation.
|
String |
getSnowballType()
The type of appliance used with this job.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAddressId(String addressId)
The ID for the address that you want the Snowball shipped to.
|
void |
setClusterId(String clusterId)
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000 . |
void |
setCreationDate(Date creationDate)
The creation date for this job.
|
void |
setDataTransferProgress(DataTransfer dataTransferProgress)
A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS.
|
void |
setDescription(String description)
The description of the job, provided at job creation.
|
void |
setForwardingAddressId(String forwardingAddressId)
The ID of the address that you want a job shipped to, after it will be shipped to its primary address.
|
void |
setJobId(String jobId)
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000 . |
void |
setJobLogInfo(JobLogs jobLogInfo)
Links to Amazon S3 presigned URLs for the job report and logs.
|
void |
setJobState(JobState jobState)
The current status of the jobs.
|
void |
setJobState(String jobState)
The current status of the jobs.
|
void |
setJobType(JobType jobType)
The type of job.
|
void |
setJobType(String jobType)
The type of job.
|
void |
setKmsKeyARN(String kmsKeyARN)
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job.
|
void |
setNotification(Notification notification)
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
|
void |
setResources(JobResource resources)
An array of
S3Resource objects. |
void |
setRoleARN(String roleARN)
The role ARN associated with this job.
|
void |
setShippingDetails(ShippingDetails shippingDetails)
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
|
void |
setSnowballCapacityPreference(SnowballCapacity snowballCapacityPreference)
The Snowball capacity preference for this job, specified at job creation.
|
void |
setSnowballCapacityPreference(String snowballCapacityPreference)
The Snowball capacity preference for this job, specified at job creation.
|
void |
setSnowballType(SnowballType snowballType)
The type of appliance used with this job.
|
void |
setSnowballType(String snowballType)
The type of appliance used with this job.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
JobMetadata |
withAddressId(String addressId)
The ID for the address that you want the Snowball shipped to.
|
JobMetadata |
withClusterId(String clusterId)
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000 . |
JobMetadata |
withCreationDate(Date creationDate)
The creation date for this job.
|
JobMetadata |
withDataTransferProgress(DataTransfer dataTransferProgress)
A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS.
|
JobMetadata |
withDescription(String description)
The description of the job, provided at job creation.
|
JobMetadata |
withForwardingAddressId(String forwardingAddressId)
The ID of the address that you want a job shipped to, after it will be shipped to its primary address.
|
JobMetadata |
withJobId(String jobId)
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000 . |
JobMetadata |
withJobLogInfo(JobLogs jobLogInfo)
Links to Amazon S3 presigned URLs for the job report and logs.
|
JobMetadata |
withJobState(JobState jobState)
The current status of the jobs.
|
JobMetadata |
withJobState(String jobState)
The current status of the jobs.
|
JobMetadata |
withJobType(JobType jobType)
The type of job.
|
JobMetadata |
withJobType(String jobType)
The type of job.
|
JobMetadata |
withKmsKeyARN(String kmsKeyARN)
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job.
|
JobMetadata |
withNotification(Notification notification)
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
|
JobMetadata |
withResources(JobResource resources)
An array of
S3Resource objects. |
JobMetadata |
withRoleARN(String roleARN)
The role ARN associated with this job.
|
JobMetadata |
withShippingDetails(ShippingDetails shippingDetails)
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
|
JobMetadata |
withSnowballCapacityPreference(SnowballCapacity snowballCapacityPreference)
The Snowball capacity preference for this job, specified at job creation.
|
JobMetadata |
withSnowballCapacityPreference(String snowballCapacityPreference)
The Snowball capacity preference for this job, specified at job creation.
|
JobMetadata |
withSnowballType(SnowballType snowballType)
The type of appliance used with this job.
|
JobMetadata |
withSnowballType(String snowballType)
The type of appliance used with this job.
|
public void setJobId(String jobId)
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000
.
jobId
- The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000
.public String getJobId()
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000
.
JID123e4567-e89b-12d3-a456-426655440000
.public JobMetadata withJobId(String jobId)
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000
.
jobId
- The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000
.public void setJobState(String jobState)
The current status of the jobs.
jobState
- The current status of the jobs.JobState
public String getJobState()
The current status of the jobs.
JobState
public JobMetadata withJobState(String jobState)
The current status of the jobs.
jobState
- The current status of the jobs.JobState
public void setJobState(JobState jobState)
The current status of the jobs.
jobState
- The current status of the jobs.JobState
public JobMetadata withJobState(JobState jobState)
The current status of the jobs.
jobState
- The current status of the jobs.JobState
public void setJobType(String jobType)
The type of job.
jobType
- The type of job.JobType
public JobMetadata withJobType(String jobType)
The type of job.
jobType
- The type of job.JobType
public void setJobType(JobType jobType)
The type of job.
jobType
- The type of job.JobType
public JobMetadata withJobType(JobType jobType)
The type of job.
jobType
- The type of job.JobType
public void setSnowballType(String snowballType)
The type of appliance used with this job.
snowballType
- The type of appliance used with this job.SnowballType
public String getSnowballType()
The type of appliance used with this job.
SnowballType
public JobMetadata withSnowballType(String snowballType)
The type of appliance used with this job.
snowballType
- The type of appliance used with this job.SnowballType
public void setSnowballType(SnowballType snowballType)
The type of appliance used with this job.
snowballType
- The type of appliance used with this job.SnowballType
public JobMetadata withSnowballType(SnowballType snowballType)
The type of appliance used with this job.
snowballType
- The type of appliance used with this job.SnowballType
public void setCreationDate(Date creationDate)
The creation date for this job.
creationDate
- The creation date for this job.public Date getCreationDate()
The creation date for this job.
public JobMetadata withCreationDate(Date creationDate)
The creation date for this job.
creationDate
- The creation date for this job.public void setResources(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.
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.public JobResource getResources()
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 JobMetadata withResources(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.
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.public void setDescription(String description)
The description of the job, provided at job creation.
description
- The description of the job, provided at job creation.public String getDescription()
The description of the job, provided at job creation.
public JobMetadata withDescription(String description)
The description of the job, provided at job creation.
description
- The description of the job, provided at job creation.public void setKmsKeyARN(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.
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 getKmsKeyARN()
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 JobMetadata withKmsKeyARN(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.
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 void setRoleARN(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).
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 getRoleARN()
The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
public JobMetadata withRoleARN(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).
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 void setAddressId(String addressId)
The ID for the address that you want the Snowball shipped to.
addressId
- The ID for the address that you want the Snowball shipped to.public String getAddressId()
The ID for the address that you want the Snowball shipped to.
public JobMetadata withAddressId(String addressId)
The ID for the address that you want the Snowball shipped to.
addressId
- The ID for the address that you want the Snowball shipped to.public void setShippingDetails(ShippingDetails shippingDetails)
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
shippingDetails
- A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.public ShippingDetails getShippingDetails()
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
public JobMetadata withShippingDetails(ShippingDetails shippingDetails)
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
shippingDetails
- A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.public void setSnowballCapacityPreference(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.
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.SnowballCapacity
public String getSnowballCapacityPreference()
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.
SnowballCapacity
public JobMetadata withSnowballCapacityPreference(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.
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.SnowballCapacity
public void setSnowballCapacityPreference(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.
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.SnowballCapacity
public JobMetadata withSnowballCapacityPreference(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.
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.SnowballCapacity
public void setNotification(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
- 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.public Notification getNotification()
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 JobMetadata withNotification(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
- 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.public void setDataTransferProgress(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.
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.public DataTransfer getDataTransferProgress()
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 JobMetadata withDataTransferProgress(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.
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.public void setJobLogInfo(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.
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 JobLogs getJobLogInfo()
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 JobMetadata withJobLogInfo(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.
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 void setClusterId(String clusterId)
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000
.
clusterId
- The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000
.public String getClusterId()
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000
.
CID123e4567-e89b-12d3-a456-426655440000
.public JobMetadata withClusterId(String clusterId)
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000
.
clusterId
- The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000
.public void setForwardingAddressId(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.
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 String getForwardingAddressId()
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 withForwardingAddressId(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.
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 String toString()
toString
in class Object
Object.toString()
public JobMetadata clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.