public static interface JobMetadata.Builder extends SdkPojo, CopyableBuilder<JobMetadata.Builder,JobMetadata>
| Modifier and Type | Method and Description |
|---|---|
JobMetadata.Builder |
addressId(String addressId)
The ID for the address that you want the Snow device 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 Snow device's data transfer while the device is at Amazon Web
Services.
|
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.
|
JobMetadata.Builder |
description(String description)
The description of the job, provided at job creation.
|
default JobMetadata.Builder |
deviceConfiguration(Consumer<DeviceConfiguration.Builder> deviceConfiguration)
Sets the value of the DeviceConfiguration property for this object.
|
JobMetadata.Builder |
deviceConfiguration(DeviceConfiguration deviceConfiguration)
Sets the value of the DeviceConfiguration property for this object.
|
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 Key Management Service (KMS) key associated with this job.
|
JobMetadata.Builder |
longTermPricingId(String longTermPricingId)
The ID of the long-term pricing type for the device.
|
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 |
onDeviceServiceConfiguration(Consumer<OnDeviceServiceConfiguration.Builder> onDeviceServiceConfiguration)
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
|
JobMetadata.Builder |
onDeviceServiceConfiguration(OnDeviceServiceConfiguration onDeviceServiceConfiguration)
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
|
JobMetadata.Builder |
remoteManagement(RemoteManagement remoteManagement)
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network.
|
JobMetadata.Builder |
remoteManagement(String remoteManagement)
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network.
|
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 Snow device capacity preference for this job, specified at job creation.
|
JobMetadata.Builder |
snowballCapacityPreference(String snowballCapacityPreference)
The Snow device 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.
|
default JobMetadata.Builder |
taxDocuments(Consumer<TaxDocuments.Builder> taxDocuments)
The metadata associated with the tax documents required in your Amazon Web Services Region.
|
JobMetadata.Builder |
taxDocuments(TaxDocuments taxDocuments)
The metadata associated with the tax documents required in your Amazon Web Services Region.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildJobMetadata.Builder jobId(String jobId)
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
jobId - The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000.JobMetadata.Builder jobState(String jobState)
The current status of the jobs.
JobMetadata.Builder jobState(JobState jobState)
The current status of the jobs.
JobMetadata.Builder jobType(String jobType)
The type of job.
JobMetadata.Builder jobType(JobType jobType)
The type of job.
JobMetadata.Builder snowballType(String snowballType)
The type of device used with this job.
snowballType - The type of device used with this job.SnowballType,
SnowballTypeJobMetadata.Builder snowballType(SnowballType snowballType)
The type of device used with this job.
snowballType - The type of device used with this job.SnowballType,
SnowballTypeJobMetadata.Builder creationDate(Instant creationDate)
The creation date for this job.
creationDate - The creation date for this job.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.
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.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.
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).
resources - a consumer that will call methods on JobResource.Builderresources(JobResource)JobMetadata.Builder description(String description)
The description of the job, provided at job creation.
description - The description of the job, provided at job creation.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.
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.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.
roleARN - The role ARN associated with this job. This ARN was created using the CreateRole API
action in Identity and Access Management.JobMetadata.Builder addressId(String addressId)
The ID for the address that you want the Snow device shipped to.
addressId - The ID for the address that you want the Snow device shipped to.JobMetadata.Builder shippingDetails(ShippingDetails shippingDetails)
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
shippingDetails - A job's shipping information, including inbound and outbound tracking numbers and shipping speed
options.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 theShippingDetails.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).
shippingDetails - a consumer that will call methods on ShippingDetails.BuildershippingDetails(ShippingDetails)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.
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.
SnowballCapacity,
SnowballCapacityJobMetadata.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.
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.
SnowballCapacity,
SnowballCapacityJobMetadata.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.
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.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.
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).
notification - a consumer that will call methods on Notification.Buildernotification(Notification)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.
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.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.
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).
dataTransferProgress - a consumer that will call methods on DataTransfer.BuilderdataTransferProgress(DataTransfer)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.
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.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 theJobLogs.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).
jobLogInfo - a consumer that will call methods on JobLogs.BuilderjobLogInfo(JobLogs)JobMetadata.Builder clusterId(String clusterId)
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
clusterId - The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.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.
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.JobMetadata.Builder taxDocuments(TaxDocuments taxDocuments)
The metadata associated with the tax documents required in your Amazon Web Services Region.
taxDocuments - The metadata associated with the tax documents required in your Amazon Web Services Region.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 theTaxDocuments.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).
taxDocuments - a consumer that will call methods on TaxDocuments.BuildertaxDocuments(TaxDocuments)JobMetadata.Builder deviceConfiguration(DeviceConfiguration deviceConfiguration)
deviceConfiguration - The new value for the DeviceConfiguration property for this object.default JobMetadata.Builder deviceConfiguration(Consumer<DeviceConfiguration.Builder> deviceConfiguration)
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).
deviceConfiguration - a consumer that will call methods on DeviceConfiguration.BuilderdeviceConfiguration(DeviceConfiguration)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.
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.RemoteManagement,
RemoteManagementJobMetadata.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.
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.RemoteManagement,
RemoteManagementJobMetadata.Builder longTermPricingId(String longTermPricingId)
The ID of the long-term pricing type for the device.
longTermPricingId - The ID of the long-term pricing type for the device.JobMetadata.Builder onDeviceServiceConfiguration(OnDeviceServiceConfiguration onDeviceServiceConfiguration)
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
onDeviceServiceConfiguration - Represents metadata and configuration settings for services on an Amazon Web Services Snow Family
device.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 theOnDeviceServiceConfiguration.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).
onDeviceServiceConfiguration - a consumer that will call methods on OnDeviceServiceConfiguration.BuilderonDeviceServiceConfiguration(OnDeviceServiceConfiguration)Copyright © 2023. All rights reserved.