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

Interface CreateJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkPojo, SdkRequest.Builder, SnowballRequest.Builder
Enclosing class:
CreateJobRequest
public static interface CreateJobRequest.Builder extends SnowballRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

  • Method Details

    • jobType

      CreateJobRequest.Builder jobType(String jobType)

      Defines the type of job that you're creating.

      Parameters:
      jobType - Defines the type of job that you're creating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobType

      CreateJobRequest.Builder jobType(JobType jobType)

      Defines the type of job that you're creating.

      Parameters:
      jobType - Defines the type of job that you're creating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resources

      CreateJobRequest.Builder resources(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      default CreateJobRequest.Builder resources(Consumer<JobResource.Builder> 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.

      This is a convenience method that creates an instance of the JobResource.Builder avoiding the need to create one manually via JobResource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resources(JobResource).

      Parameters:
      resources - a consumer that will call methods on JobResource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onDeviceServiceConfiguration

      CreateJobRequest.Builder onDeviceServiceConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • onDeviceServiceConfiguration

      default CreateJobRequest.Builder onDeviceServiceConfiguration(Consumer<OnDeviceServiceConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the OnDeviceServiceConfiguration.Builder avoiding the need to create one manually via OnDeviceServiceConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onDeviceServiceConfiguration(OnDeviceServiceConfiguration).

      Parameters:
      onDeviceServiceConfiguration - a consumer that will call methods on OnDeviceServiceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateJobRequest.Builder description(String description)

      Defines an optional description of this specific job, for example Important Photos 2016-08-11.

      Parameters:
      description - Defines an optional description of this specific job, for example Important Photos 2016-08-11.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressId

      CreateJobRequest.Builder addressId(String addressId)

      The ID for the address that you want the Snow device shipped to.

      Parameters:
      addressId - The ID for the address that you want the Snow device shipped to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyARN

      CreateJobRequest.Builder kmsKeyARN(String kmsKeyARN)

      The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action.

      Parameters:
      kmsKeyARN - The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleARN

      CreateJobRequest.Builder roleARN(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • snowballCapacityPreference

      CreateJobRequest.Builder snowballCapacityPreference(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snowballCapacityPreference

      CreateJobRequest.Builder snowballCapacityPreference(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shippingOption

      CreateJobRequest.Builder shippingOption(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shippingOption

      CreateJobRequest.Builder shippingOption(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notification

      CreateJobRequest.Builder notification(Notification notification)

      Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

      Parameters:
      notification - Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notification

      default CreateJobRequest.Builder notification(Consumer<Notification.Builder> notification)

      Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

      This is a convenience method that creates an instance of the Notification.Builder avoiding the need to create one manually via Notification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notification(Notification).

      Parameters:
      notification - a consumer that will call methods on Notification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clusterId

      CreateJobRequest.Builder clusterId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • snowballType

      CreateJobRequest.Builder snowballType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snowballType

      CreateJobRequest.Builder snowballType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • forwardingAddressId

      CreateJobRequest.Builder forwardingAddressId(String forwardingAddressId)

      The forwarding address ID for a job. This field is not supported in most Regions.

      Parameters:
      forwardingAddressId - The forwarding address ID for a job. This field is not supported in most Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taxDocuments

      CreateJobRequest.Builder taxDocuments(TaxDocuments taxDocuments)

      The tax documents required in your Amazon Web Services Region.

      Parameters:
      taxDocuments - The tax documents required in your Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taxDocuments

      default CreateJobRequest.Builder taxDocuments(Consumer<TaxDocuments.Builder> taxDocuments)

      The tax documents required in your Amazon Web Services Region.

      This is a convenience method that creates an instance of the TaxDocuments.Builder avoiding the need to create one manually via TaxDocuments.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taxDocuments(TaxDocuments).

      Parameters:
      taxDocuments - a consumer that will call methods on TaxDocuments.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deviceConfiguration

      CreateJobRequest.Builder deviceConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfiguration

      default CreateJobRequest.Builder deviceConfiguration(Consumer<DeviceConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the DeviceConfiguration.Builder avoiding the need to create one manually via DeviceConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfiguration(DeviceConfiguration).

      Parameters:
      deviceConfiguration - a consumer that will call methods on DeviceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • remoteManagement

      CreateJobRequest.Builder remoteManagement(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • remoteManagement

      CreateJobRequest.Builder remoteManagement(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • longTermPricingId

      CreateJobRequest.Builder longTermPricingId(String longTermPricingId)

      The ID of the long-term pricing type for the device.

      Parameters:
      longTermPricingId - The ID of the long-term pricing type for the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impactLevel

      CreateJobRequest.Builder impactLevel(String impactLevel)

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

      Parameters:
      impactLevel - The highest impact level of data that will be stored or processed on the device, provided at job creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • impactLevel

      CreateJobRequest.Builder impactLevel(ImpactLevel impactLevel)

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

      Parameters:
      impactLevel - The highest impact level of data that will be stored or processed on the device, provided at job creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pickupDetails

      CreateJobRequest.Builder pickupDetails(PickupDetails pickupDetails)

      Information identifying the person picking up the device.

      Parameters:
      pickupDetails - Information identifying the person picking up the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pickupDetails

      default CreateJobRequest.Builder pickupDetails(Consumer<PickupDetails.Builder> pickupDetails)

      Information identifying the person picking up the device.

      This is a convenience method that creates an instance of the PickupDetails.Builder avoiding the need to create one manually via PickupDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pickupDetails(PickupDetails).

      Parameters:
      pickupDetails - a consumer that will call methods on PickupDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.