@Generated(value="software.amazon.awssdk:codegen") public final class CreateJobRequest extends SnowballRequest implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateJobRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
addressId()
The ID for the address that you want the Snowball 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 . |
boolean |
equals(Object obj) |
String |
forwardingAddressId()
The forwarding address ID for a job.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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. |
Notification |
notification()
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
|
JobResource |
resources()
Defines the Amazon S3 buckets associated with this job.
|
String |
roleARN()
The
RoleARN that you want to associate with this job. |
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 Snowball 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 Snowball you'd
like for this job.
|
SnowballType |
snowballType()
The type of AWS Snowball appliance to use for this job.
|
String |
snowballTypeAsString()
The type of AWS Snowball appliance to use for this job.
|
CreateJobRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public 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()
.
JobType
public 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()
.
JobType
public 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.
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.
public String description()
Defines an optional description of this specific job, for example Important Photos 2016-08-11
.
Important Photos 2016-08-11
.public String addressId()
The ID for the address that you want the Snowball shipped to.
public String kmsKeyARN()
The KmsKeyARN
that you want to associate with this job. KmsKeyARN
s are created using
the CreateKey AWS Key
Management Service (KMS) API action.
KmsKeyARN
that you want to associate with this job. KmsKeyARN
s are created
using the CreateKey
AWS Key Management Service (KMS) API action.public String roleARN()
The RoleARN
that you want to associate with this job. RoleArn
s are created using the CreateRole AWS Identity and
Access Management (IAM) API action.
RoleARN
that you want to associate with this job. RoleArn
s are created
using the CreateRole
AWS Identity and Access Management (IAM) API action.public SnowballCapacity snowballCapacityPreference()
If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
If the service returns an enum value that is not available in the current SDK version,
snowballCapacityPreference
will return SnowballCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from snowballCapacityPreferenceAsString()
.
SnowballCapacity
public String snowballCapacityPreferenceAsString()
If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
If the service returns an enum value that is not available in the current SDK version,
snowballCapacityPreference
will return SnowballCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from snowballCapacityPreferenceAsString()
.
SnowballCapacity
public ShippingOption shippingOption()
The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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()
.
In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
ShippingOption
public String shippingOptionAsString()
The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:
In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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()
.
In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
ShippingOption
public Notification notification()
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
public 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.
clusterId
value. The other job attributes are inherited from the cluster.public SnowballType snowballType()
The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster
jobs is EDGE
.
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()
.
EDGE
.SnowballType
public String snowballTypeAsString()
The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster
jobs is EDGE
.
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()
.
EDGE
.SnowballType
public String forwardingAddressId()
The forwarding address ID for a job. This field is not supported in most regions.
public CreateJobRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
toBuilder
in class SnowballRequest
public static CreateJobRequest.Builder builder()
public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.