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 Summary

Modifier and Type	Method and Description
JobMetadata.Builder	addressId(String addressId) The ID for the address that you want the Snowball shipped to.
JobMetadata.Builder	clusterId(String clusterId) The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
JobMetadata.Builder	creationDate(Instant creationDate) The creation date for this job.
default JobMetadata.Builder	dataTransferProgress(Consumer<DataTransfer.Builder> dataTransferProgress) A value that defines the real-time status of a Snowball's data transfer while the device is at AWS.
JobMetadata.Builder	dataTransferProgress(DataTransfer dataTransferProgress) A value that defines the real-time status of a Snowball's data transfer while the device is at AWS.
JobMetadata.Builder	description(String description) The description of the job, provided at job creation.
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.
JobMetadata.Builder	jobId(String jobId) The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
default JobMetadata.Builder	jobLogInfo(Consumer<JobLogs.Builder> jobLogInfo) Links to Amazon S3 presigned URLs for the job report and logs.
JobMetadata.Builder	jobLogInfo(JobLogs jobLogInfo) Links to Amazon S3 presigned URLs for the job report and logs.
JobMetadata.Builder	jobState(JobState jobState) The current status of the jobs.
JobMetadata.Builder	jobState(String jobState) The current status of the jobs.
JobMetadata.Builder	jobType(JobType jobType) The type of job.
JobMetadata.Builder	jobType(String jobType) The type of job.
JobMetadata.Builder	kmsKeyARN(String kmsKeyARN) The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job.
default JobMetadata.Builder	notification(Consumer<Notification.Builder> notification) The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
JobMetadata.Builder	notification(Notification notification) The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
default JobMetadata.Builder	resources(Consumer<JobResource.Builder> resources) An array of S3Resource objects.
JobMetadata.Builder	resources(JobResource resources) An array of S3Resource objects.
JobMetadata.Builder	roleARN(String roleARN) The role ARN associated with this job.
default JobMetadata.Builder	shippingDetails(Consumer<ShippingDetails.Builder> shippingDetails) A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
JobMetadata.Builder	shippingDetails(ShippingDetails shippingDetails) A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
JobMetadata.Builder	snowballCapacityPreference(SnowballCapacity snowballCapacityPreference) The Snowball capacity preference for this job, specified at job creation.
JobMetadata.Builder	snowballCapacityPreference(String snowballCapacityPreference) The Snowball capacity preference for this job, specified at job creation.
JobMetadata.Builder	snowballType(SnowballType snowballType) The type of device used with this job.
JobMetadata.Builder	snowballType(String snowballType) The type of device used with this job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

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, JobState

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:

JobState, JobState

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, JobType

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:

JobType, JobType

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, SnowballType

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:

SnowballType, SnowballType

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

resources(JobResource)

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 AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

Parameters:

kmsKeyARN - The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS 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 AWS Identity and Access Management (IAM).

Parameters:

roleARN - The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

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 Snowball shipped to.

Parameters:

addressId - The ID for the address that you want the Snowball 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 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:

shippingDetails(ShippingDetails)

snowballCapacityPreference

JobMetadata.Builder snowballCapacityPreference(String snowballCapacityPreference)

The Snowball 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.

Parameters:

snowballCapacityPreference - The Snowball 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.

Returns:

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

See Also:

SnowballCapacity, SnowballCapacity

snowballCapacityPreference

JobMetadata.Builder snowballCapacityPreference(SnowballCapacity snowballCapacityPreference)

The Snowball 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.

Parameters:

snowballCapacityPreference - The Snowball 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.

Returns:

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

See Also:

SnowballCapacity, SnowballCapacity

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

notification(Notification)

dataTransferProgress

JobMetadata.Builder dataTransferProgress(DataTransfer dataTransferProgress)

A value that defines the real-time status of a Snowball's data transfer while the device is at AWS. 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 Snowball's data transfer while the device is at AWS. 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 Snowball's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

This is a convenience 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:

dataTransferProgress(DataTransfer)

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 Snowball 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 Snowball 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 Snowball for your job part is being delivered to you.

This is a convenience 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:

jobLogInfo(JobLogs)

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.