JobMetadata (AWS Java SDK for Amazon Snowball 1.11.46 API)

java.lang.Object
- com.amazonaws.services.snowball.model.JobMetadata

All Implemented Interfaces:

Serializable, Cloneable
```
public class JobMetadata
extends Object
implements Serializable, Cloneable
```
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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobMetadata()

Constructors
Constructor and Description
`JobMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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`	`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 state 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.
`int`	`hashCode()`
`void`	`setAddressId(String addressId)` The ID for the address that you want the Snowball shipped to.
`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`	`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 state of the jobs.
`void`	`setJobState(String jobState)` The current state 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.
`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`	`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`	`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 state of the jobs.
`JobMetadata`	`withJobState(String jobState)` The current state 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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobMetadata
```
public JobMetadata()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
    
    Parameters:
    
    jobId - The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
  - getJobId
```
public String getJobId()
```
    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.
  - withJobId
```
public JobMetadata withJobId(String jobId)
```
    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
    
    Parameters:
    
    jobId - The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobState
```
public void setJobState(String jobState)
```
    The current state of the jobs.
    
    Parameters:
    
    jobState - The current state of the jobs.
    
    See Also:
    
    JobState
  - getJobState
```
public String getJobState()
```
    The current state of the jobs.
    
    Returns:
    
    The current state of the jobs.
    
    See Also:
    
    JobState
  - withJobState
```
public JobMetadata withJobState(String jobState)
```
    The current state of the jobs.
    
    Parameters:
    
    jobState - The current state of the jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobState
  - setJobState
```
public void setJobState(JobState jobState)
```
    The current state of the jobs.
    
    Parameters:
    
    jobState - The current state of the jobs.
    
    See Also:
    
    JobState
  - withJobState
```
public JobMetadata withJobState(JobState jobState)
```
    The current state of the jobs.
    
    Parameters:
    
    jobState - The current state of the jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobState
  - setJobType
```
public void setJobType(String jobType)
```
    The type of job.
    
    Parameters:
    
    jobType - The type of job.
    
    See Also:
    
    JobType
  - getJobType
```
public String getJobType()
```
    The type of job.
    
    Returns:
    
    The type of job.
    
    See Also:
    
    JobType
  - withJobType
```
public JobMetadata withJobType(String jobType)
```
    The type of job.
    
    Parameters:
    
    jobType - The type of job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - setJobType
```
public void setJobType(JobType jobType)
```
    The type of job.
    
    Parameters:
    
    jobType - The type of job.
    
    See Also:
    
    JobType
  - withJobType
```
public JobMetadata withJobType(JobType jobType)
```
    The type of job.
    
    Parameters:
    
    jobType - The type of job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The creation date for this job.
    
    Parameters:
    
    creationDate - The creation date for this job.
  - getCreationDate
```
public Date getCreationDate()
```
    The creation date for this job.
    
    Returns:
    
    The creation date for this job.
  - withCreationDate
```
public JobMetadata withCreationDate(Date creationDate)
```
    The creation date for this job.
    
    Parameters:
    
    creationDate - The creation date for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResources
```
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.
    
    Parameters:
    
    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.
  - getResources
```
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.
    
    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.
  - withResources
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the job, provided at job creation.
    
    Parameters:
    
    description - The description of the job, provided at job creation.
  - getDescription
```
public String getDescription()
```
    The description of the job, provided at job creation.
    
    Returns:
    
    The description of the job, provided at job creation.
  - withDescription
```
public JobMetadata withDescription(String description)
```
    The description of the job, provided at job creation.
    
    Parameters:
    
    description - The description of the job, provided at job creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyARN
```
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.
    
    Parameters:
    
    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.
  - getKmsKeyARN
```
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.
    
    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.
  - withKmsKeyARN
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleARN
```
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).
    
    Parameters:
    
    roleARN - The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
  - getRoleARN
```
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).
    
    Returns:
    
    The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
  - withRoleARN
```
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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAddressId
```
public void setAddressId(String addressId)
```
    The ID for the address that you want the Snowball shipped to.
    
    Parameters:
    
    addressId - The ID for the address that you want the Snowball shipped to.
  - getAddressId
```
public String getAddressId()
```
    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.
  - withAddressId
```
public JobMetadata withAddressId(String addressId)
```
    The ID for the address that you want the Snowball shipped to.
    
    Parameters:
    
    addressId - The ID for the address that you want the Snowball shipped to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setShippingDetails
```
public void setShippingDetails(ShippingDetails shippingDetails)
```
    A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
    
    Parameters:
    
    shippingDetails - A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
  - getShippingDetails
```
public ShippingDetails getShippingDetails()
```
    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.
  - withShippingDetails
```
public JobMetadata withShippingDetails(ShippingDetails shippingDetails)
```
    A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
    
    Parameters:
    
    shippingDetails - A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnowballCapacityPreference
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    SnowballCapacity
  - getSnowballCapacityPreference
```
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.
    
    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
  - withSnowballCapacityPreference
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SnowballCapacity
  - setSnowballCapacityPreference
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    SnowballCapacity
  - withSnowballCapacityPreference
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SnowballCapacity
  - setNotification
```
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.
    
    Parameters:
    
    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.
  - getNotification
```
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.
    
    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.
  - withNotification
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataTransferProgress
```
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. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs.
    
    Parameters:
    
    dataTransferProgress - A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs.
  - getDataTransferProgress
```
public DataTransfer getDataTransferProgress()
```
    A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. Note that 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. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs.
  - withDataTransferProgress
```
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. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs.
    
    Parameters:
    
    dataTransferProgress - A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. Note that this data is only available while a job has a JobState value of InProgress, for both import and export jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobLogInfo
```
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.
    
    Parameters:
    
    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.
  - getJobLogInfo
```
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.
    
    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.
  - withJobLogInfo
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JobMetadata clone()
```
    Overrides:
    
    clone in class Object

Class JobMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobMetadata

Method Detail

setJobId

getJobId

withJobId

setJobState

getJobState

withJobState

setJobState

withJobState

setJobType

getJobType

withJobType

setJobType

withJobType

setCreationDate

getCreationDate

withCreationDate

setResources

getResources

withResources

setDescription

getDescription

withDescription

setKmsKeyARN

getKmsKeyARN

withKmsKeyARN

setRoleARN

getRoleARN

withRoleARN

setAddressId

getAddressId

withAddressId

setShippingDetails

getShippingDetails

withShippingDetails

setSnowballCapacityPreference

getSnowballCapacityPreference

withSnowballCapacityPreference

setSnowballCapacityPreference

withSnowballCapacityPreference

setNotification

getNotification

withNotification

setDataTransferProgress

getDataTransferProgress

withDataTransferProgress

setJobLogInfo

getJobLogInfo

withJobLogInfo

toString

equals

hashCode

clone