Package software.amazon.awssdk.services.snowball.model

Class CreateJobRequest

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("software.amazon.awssdk:codegen") public final class CreateJobRequest extends SnowballRequest implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on 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 Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on the device.
      See Also:

    • 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 Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on 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 Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on the device.
      See Also:

    • 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.

    • impactLevel

      public final ImpactLevel impactLevel()

      The highest impact level of data that will be stored or processed on the device, provided at job creation.

      If the service returns an enum value that is not available in the current SDK version, impactLevel will return ImpactLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from impactLevelAsString().

      Returns:
      The highest impact level of data that will be stored or processed on the device, provided at job creation.
      See Also:

    • impactLevelAsString

      public final String impactLevelAsString()

      The highest impact level of data that will be stored or processed on the device, provided at job creation.

      If the service returns an enum value that is not available in the current SDK version, impactLevel will return ImpactLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from impactLevelAsString().

      Returns:
      The highest impact level of data that will be stored or processed on the device, provided at job creation.
      See Also:

    • pickupDetails

      public final PickupDetails pickupDetails()

      Information identifying the person picking up the device.

      Returns:
      Information identifying the person picking up the device.

    • toBuilder

      public CreateJobRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
      Specified by:
      toBuilder in class SnowballRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.