JobMetadata (AWS Java SDK :: Services :: Amazon Snowball 2.16.97 API)

java.lang.Object
- software.amazon.awssdk.services.snowball.model.JobMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobMetadata.Builder,JobMetadata>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class JobMetadata
extends Object
implements SdkPojo, Serializable, 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobMetadata.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobMetadata.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addressId()` The ID for the address that you want the Snow device 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 Snow device's data transfer while the device is at AWS.
`String`	`description()` The description of the job, provided at job creation.
`DeviceConfiguration`	`deviceConfiguration()` Returns the value of the DeviceConfiguration property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(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.
`String`	`longTermPricingId()` The ID of the long-term pricing type for the device.
`Notification`	`notification()` The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
`OnDeviceServiceConfiguration`	`onDeviceServiceConfiguration()` Represents metadata and configuration settings for services on an AWS Snow Family device.
`RemoteManagement`	`remoteManagement()` Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network.
`String`	`remoteManagementAsString()` Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network.
`JobResource`	`resources()` An array of `S3Resource` objects.
`String`	`roleARN()` The role ARN associated with this job.
`List<SdkField<?>>`	`sdkFields()`
`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 Snow device capacity preference for this job, specified at job creation.
`String`	`snowballCapacityPreferenceAsString()` The Snow device capacity preference for this job, specified at job creation.
`SnowballType`	`snowballType()` The type of device used with this job.
`String`	`snowballTypeAsString()` The type of device used with this job.
`TaxDocuments`	`taxDocuments()` The metadata associated with the tax documents required in your AWS Region.
`JobMetadata.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

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

- Method Detail
  - jobId
```
public final 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 final 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().
    
    Returns:
    
    The current status of the jobs.
    
    See Also:
    
    JobState
  - jobStateAsString
```
public final 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().
    
    Returns:
    
    The current status of the jobs.
    
    See Also:
    
    JobState
  - jobType
```
public final 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 final 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 final SnowballType snowballType()
```
    The type of device 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 device used with this job.
    
    See Also:
    
    SnowballType
  - snowballTypeAsString
```
public final String snowballTypeAsString()
```
    The type of device 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 device used with this job.
    
    See Also:
    
    SnowballType
  - creationDate
```
public final Instant creationDate()
```
    The creation date for this job.
    
    Returns:
    
    The creation date for this job.
  - resources
```
public final 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 final String description()
```
    The description of the job, provided at job creation.
    
    Returns:
    
    The description of the job, provided at job creation.
  - kmsKeyARN
```
public final 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 final 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 final String addressId()
```
    The ID for the address that you want the Snow device shipped to.
    
    Returns:
    
    The ID for the address that you want the Snow device shipped to.
  - shippingDetails
```
public final 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 final SnowballCapacity snowballCapacityPreference()
```
    The Snow device 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.
    
    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
    
    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().
    
    Returns:
    
    The Snow device 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.
    
    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
    
    See Also:
    
    SnowballCapacity
  - snowballCapacityPreferenceAsString
```
public final String snowballCapacityPreferenceAsString()
```
    The Snow device 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.
    
    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
    
    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().
    
    Returns:
    
    The Snow device 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.
    
    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
    
    See Also:
    
    SnowballCapacity
  - notification
```
public final 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 final DataTransfer dataTransferProgress()
```
    A value that defines the real-time status of a Snow device's data transfer while the device 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 Snow device's data transfer while the device 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 final 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 Snow device 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 Snow device for your job part is being delivered to you.
  - clusterId
```
public final 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 final 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.
  - taxDocuments
```
public final TaxDocuments taxDocuments()
```
    The metadata associated with the tax documents required in your AWS Region.
    
    Returns:
    
    The metadata associated with the tax documents required in your AWS Region.
  - deviceConfiguration
```
public final DeviceConfiguration deviceConfiguration()
```
    Returns the value of the DeviceConfiguration property for this object.
    
    Returns:
    
    The value of the DeviceConfiguration property for this object.
  - remoteManagement
```
public final RemoteManagement remoteManagement()
```
    Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
    
    If the service returns an enum value that is not available in the current SDK version, remoteManagement will return RemoteManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from remoteManagementAsString().
    
    Returns:
    
    Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
    
    See Also:
    
    RemoteManagement
  - remoteManagementAsString
```
public final String remoteManagementAsString()
```
    Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
    
    If the service returns an enum value that is not available in the current SDK version, remoteManagement will return RemoteManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from remoteManagementAsString().
    
    Returns:
    
    Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
    
    See Also:
    
    RemoteManagement
  - longTermPricingId
```
public final String longTermPricingId()
```
    The ID of the long-term pricing type for the device.
    
    Returns:
    
    The ID of the long-term pricing type for the device.
  - onDeviceServiceConfiguration
```
public final OnDeviceServiceConfiguration onDeviceServiceConfiguration()
```
    Represents metadata and configuration settings for services on an AWS Snow Family device.
    
    Returns:
    
    Represents metadata and configuration settings for services on an AWS Snow Family device.
  - toBuilder
```
public JobMetadata.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobMetadata.Builder,JobMetadata>
  - builder
```
public static JobMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobMetadata.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

jobId

jobState

jobStateAsString

jobType

jobTypeAsString

snowballType

snowballTypeAsString

creationDate

resources

description

kmsKeyARN

roleARN

addressId

shippingDetails

snowballCapacityPreference

snowballCapacityPreferenceAsString

notification

dataTransferProgress

jobLogInfo

clusterId

forwardingAddressId

taxDocuments

deviceConfiguration

remoteManagement

remoteManagementAsString

longTermPricingId

onDeviceServiceConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields