CreateJobRequest (AWS Java SDK :: Services :: Amazon Snowball 2.18.12 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.snowball.model.SnowballRequest
    - - software.amazon.awssdk.services.snowball.model.CreateJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateJobRequest
extends SnowballRequest
implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateJobRequest.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 CreateJobRequest.Builder`	`builder()`
`String`	`clusterId()` The ID of a cluster.
`String`	`description()` Defines an optional description of this specific job, for example `Important Photos 2016-08-11`.
`DeviceConfiguration`	`deviceConfiguration()` Defines the device configuration for an Snowcone job.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`forwardingAddressId()` The forwarding address ID for a job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`JobType`	`jobType()` Defines the type of job that you're creating.
`String`	`jobTypeAsString()` Defines the type of job that you're creating.
`String`	`kmsKeyARN()` The `KmsKeyARN` that you want to associate with this job.
`String`	`longTermPricingId()` The ID of the long-term pricing type for the device.
`Notification`	`notification()` Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
`OnDeviceServiceConfiguration`	`onDeviceServiceConfiguration()` Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.
`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()` Defines the Amazon S3 buckets associated with this job.
`String`	`roleARN()` The `RoleARN` that you want to associate with this job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateJobRequest.Builder>`	`serializableBuilderClass()`
`ShippingOption`	`shippingOption()` The shipping speed for this job.
`String`	`shippingOptionAsString()` The shipping speed for this job.
`SnowballCapacity`	`snowballCapacityPreference()` If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job.
`String`	`snowballCapacityPreferenceAsString()` If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job.
`SnowballType`	`snowballType()` The type of Snow Family devices to use for this job.
`String`	`snowballTypeAsString()` The type of Snow Family devices to use for this job.
`TaxDocuments`	`taxDocuments()` The tax documents required in your Amazon Web Services Region.
`CreateJobRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - jobType
```
public final JobType jobType()
```
    Defines the type of job that you're creating.
    
    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:
    
    Defines the type of job that you're creating.
    
    See Also:
    
    JobType
  - jobTypeAsString
```
public final String jobTypeAsString()
```
    Defines the type of job that you're creating.
    
    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:
    
    Defines the type of job that you're creating.
    
    See Also:
    
    JobType
  - resources
```
public final JobResource resources()
```
    Defines the Amazon S3 buckets associated with this job.
    
    With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.
    
    With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.
    
    Returns:
    
    Defines the Amazon S3 buckets associated with this job.
    
    With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.
    
    With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.
  - onDeviceServiceConfiguration
```
public final OnDeviceServiceConfiguration onDeviceServiceConfiguration()
```
    Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
    
    Returns:
    
    Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
  - description
```
public final String description()
```
    Defines an optional description of this specific job, for example Important Photos 2016-08-11.
    
    Returns:
    
    Defines an optional description of this specific job, for example Important Photos 2016-08-11.
  - 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.
  - kmsKeyARN
```
public final String kmsKeyARN()
```
    The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action.
    
    Returns:
    
    The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action.
  - roleARN
```
public final String roleARN()
```
    The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole Identity and Access Management (IAM) API action.
    
    Returns:
    
    The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole Identity and Access Management (IAM) API action.
  - snowballCapacityPreference
```
public final SnowballCapacity snowballCapacityPreference()
```
    If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
    
    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:
    
    If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
    
    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()
```
    If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
    
    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:
    
    If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
    
    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
  - shippingOption
```
public final ShippingOption shippingOption()
```
    The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
    - In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
    - In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    - In India, Snow devices are delivered in one to seven days.
    - In the US, you have access to one-day shipping and two-day shipping.
    If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().
    Returns:
    The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
    
    In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
    
    In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    
    In India, Snow devices are delivered in one to seven days.
    
    In the US, you have access to one-day shipping and two-day shipping.
    See Also:
    
    ShippingOption
  - shippingOptionAsString
```
public final String shippingOptionAsString()
```
    The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
    - In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
    - In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    - In India, Snow devices are delivered in one to seven days.
    - In the US, you have access to one-day shipping and two-day shipping.
    If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().
    Returns:
    The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
    
    In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
    
    In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
    
    In India, Snow devices are delivered in one to seven days.
    
    In the US, you have access to one-day shipping and two-day shipping.
    See Also:
    
    ShippingOption
  - notification
```
public final Notification notification()
```
    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
    
    Returns:
    
    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
  - clusterId
```
public final String clusterId()
```
    The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.
    
    Returns:
    
    The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.
  - snowballType
```
public final SnowballType snowballType()
```
    The type of Snow Family devices to use for this job.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.
    
    For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.
    
    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, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().
    
    Returns:
    
    The type of Snow Family devices to use for this job.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.
    
    For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.
    
    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:
    
    SnowballType
  - snowballTypeAsString
```
public final String snowballTypeAsString()
```
    The type of Snow Family devices to use for this job.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.
    
    For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.
    
    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, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().
    
    Returns:
    
    The type of Snow Family devices to use for this job.
    
    For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
    
    The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.
    
    For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.
    
    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:
    
    SnowballType
  - forwardingAddressId
```
public final String forwardingAddressId()
```
    The forwarding address ID for a job. This field is not supported in most Regions.
    
    Returns:
    
    The forwarding address ID for a job. This field is not supported in most Regions.
  - taxDocuments
```
public final TaxDocuments taxDocuments()
```
    The tax documents required in your Amazon Web Services Region.
    
    Returns:
    
    The tax documents required in your Amazon Web Services Region.
  - deviceConfiguration
```
public final DeviceConfiguration deviceConfiguration()
```
    Defines the device configuration for an Snowcone job.
    
    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.
    
    Returns:
    
    Defines the device configuration for an Snowcone job.
    
    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.
  - 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.
  - toBuilder
```
public CreateJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
    
    Specified by:
    
    toBuilder in class SnowballRequest
  - builder
```
public static CreateJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

jobType

jobTypeAsString

resources

onDeviceServiceConfiguration

description

addressId

kmsKeyARN

roleARN

snowballCapacityPreference

snowballCapacityPreferenceAsString

shippingOption

shippingOptionAsString

notification

clusterId

snowballType

snowballTypeAsString

forwardingAddressId

taxDocuments

deviceConfiguration

remoteManagement

remoteManagementAsString

longTermPricingId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields