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

Interface JobMetadata.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JobMetadata.Builder,JobMetadata>, SdkBuilder<JobMetadata.Builder,JobMetadata>, SdkPojo
Enclosing class:
JobMetadata
public static interface JobMetadata.Builder extends SdkPojo, CopyableBuilder<JobMetadata.Builder,JobMetadata>

  • Method Details

    • jobId

      JobMetadata.Builder jobId(String jobId)

      The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

      Parameters:
      jobId - The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobState

      JobMetadata.Builder jobState(String jobState)

      The current status of the jobs.

      Parameters:
      jobState - The current status of the jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobState

      JobMetadata.Builder jobState(JobState jobState)

      The current status of the jobs.

      Parameters:
      jobState - The current status of the jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobType

      JobMetadata.Builder jobType(String jobType)

      The type of job.

      Parameters:
      jobType - The type of job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobType

      JobMetadata.Builder jobType(JobType jobType)

      The type of job.

      Parameters:
      jobType - The type of job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snowballType

      JobMetadata.Builder snowballType(String snowballType)

      The type of device used with this job.

      Parameters:
      snowballType - The type of device used with this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snowballType

      JobMetadata.Builder snowballType(SnowballType snowballType)

      The type of device used with this job.

      Parameters:
      snowballType - The type of device used with this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

      JobMetadata.Builder creationDate(Instant creationDate)

      The creation date for this job.

      Parameters:
      creationDate - The creation date for this job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

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

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

    • resources

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

      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:

    • description

      JobMetadata.Builder description(String description)

      The description of the job, provided at job creation.

      Parameters:
      description - The description of the job, provided at job creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyARN

      JobMetadata.Builder kmsKeyARN(String kmsKeyARN)

      The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS.

      Parameters:
      kmsKeyARN - The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleARN

      JobMetadata.Builder roleARN(String roleARN)

      The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.

      Parameters:
      roleARN - The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addressId

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

    • shippingDetails

      JobMetadata.Builder shippingDetails(ShippingDetails shippingDetails)

      A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

      Parameters:
      shippingDetails - A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shippingDetails

      default JobMetadata.Builder shippingDetails(Consumer<ShippingDetails.Builder> shippingDetails)

      A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

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

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

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

    • snowballCapacityPreference

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

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

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

    • snowballCapacityPreference

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

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

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

    • notification

      JobMetadata.Builder notification(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.

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

    • notification

      default JobMetadata.Builder notification(Consumer<Notification.Builder> 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.

      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:

    • dataTransferProgress

      JobMetadata.Builder dataTransferProgress(DataTransfer dataTransferProgress)

      A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

      Parameters:
      dataTransferProgress - A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataTransferProgress

      default JobMetadata.Builder dataTransferProgress(Consumer<DataTransfer.Builder> dataTransferProgress)

      A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

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

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

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

    • jobLogInfo

      JobMetadata.Builder jobLogInfo(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.

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

    • jobLogInfo

      default JobMetadata.Builder jobLogInfo(Consumer<JobLogs.Builder> 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.

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

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

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

    • clusterId

      JobMetadata.Builder clusterId(String clusterId)

      The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

      Parameters:
      clusterId - The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forwardingAddressId

      JobMetadata.Builder forwardingAddressId(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.

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

    • taxDocuments

      JobMetadata.Builder taxDocuments(TaxDocuments taxDocuments)

      The metadata associated with the tax documents required in your Amazon Web Services Region.

      Parameters:
      taxDocuments - The metadata associated with 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 JobMetadata.Builder taxDocuments(Consumer<TaxDocuments.Builder> taxDocuments)

      The metadata associated with 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

      JobMetadata.Builder deviceConfiguration(DeviceConfiguration deviceConfiguration)
      Sets the value of the DeviceConfiguration property for this object.
      Parameters:
      deviceConfiguration - The new value for the DeviceConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfiguration

      default JobMetadata.Builder deviceConfiguration(Consumer<DeviceConfiguration.Builder> deviceConfiguration)
      Sets the value of the DeviceConfiguration property for this object. 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

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

    • remoteManagement

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

    • longTermPricingId

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

    • onDeviceServiceConfiguration

      JobMetadata.Builder onDeviceServiceConfiguration(OnDeviceServiceConfiguration onDeviceServiceConfiguration)

      Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

      Parameters:
      onDeviceServiceConfiguration - Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onDeviceServiceConfiguration

      default JobMetadata.Builder onDeviceServiceConfiguration(Consumer<OnDeviceServiceConfiguration.Builder> onDeviceServiceConfiguration)

      Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

      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:

    • impactLevel

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

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

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

    • snowballId

      JobMetadata.Builder snowballId(String snowballId)

      Unique ID associated with a device.

      Parameters:
      snowballId - Unique ID associated with a device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.