Class JobParameters
- All Implemented Interfaces:
Serializable
,Cloneable
Provides options for defining a job.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for JobParameters object.JobParameters
(String format, String type, String archiveId, String description) Constructs a new JobParameters object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The ID of the archive that you want to retrieve.The optional description for the job.When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.Input parameters used for range inventory retrieval.The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved.The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.getType()
The job type.int
hashCode()
void
setArchiveId
(String archiveId) The ID of the archive that you want to retrieve.void
setDescription
(String description) The optional description for the job.void
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.void
setInventoryRetrievalParameters
(InventoryRetrievalJobInput inventoryRetrievalParameters) Input parameters used for range inventory retrieval.void
setRetrievalByteRange
(String retrievalByteRange) The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved.void
setSNSTopic
(String sNSTopic) The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.void
The job type.toString()
Returns a string representation of this object; useful for testing and debugging.withArchiveId
(String archiveId) The ID of the archive that you want to retrieve.withDescription
(String description) The optional description for the job.withFormat
(String format) When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format.withInventoryRetrievalParameters
(InventoryRetrievalJobInput inventoryRetrievalParameters) Input parameters used for range inventory retrieval.withRetrievalByteRange
(String retrievalByteRange) The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved.withSNSTopic
(String sNSTopic) The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download.The job type.
-
Constructor Details
-
JobParameters
public JobParameters()Default constructor for JobParameters object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
JobParameters
Constructs a new JobParameters object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
format
- When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".type
- The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".archiveId
- The ID of the archive that you want to retrieve. This field is required only ifType
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.description
- The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
-
-
Method Details
-
setFormat
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
- Parameters:
format
- When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
-
getFormat
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
- Returns:
- When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
-
withFormat
When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".
- Parameters:
format
- When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".
- Parameters:
type
- The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".
-
getType
The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".
- Returns:
- The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".
-
withType
The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".
- Parameters:
type
- The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setArchiveId
The ID of the archive that you want to retrieve. This field is required only if
Type
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.- Parameters:
archiveId
- The ID of the archive that you want to retrieve. This field is required only ifType
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
-
getArchiveId
The ID of the archive that you want to retrieve. This field is required only if
Type
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.- Returns:
- The ID of the archive that you want to retrieve. This field is
required only if
Type
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.
-
withArchiveId
The ID of the archive that you want to retrieve. This field is required only if
Type
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.- Parameters:
archiveId
- The ID of the archive that you want to retrieve. This field is required only ifType
is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
- Parameters:
description
- The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
-
getDescription
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
- Returns:
- The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
-
withDescription
The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.
- Parameters:
description
- The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSNSTopic
The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
- Parameters:
sNSTopic
- The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
-
getSNSTopic
The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
- Returns:
- The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
-
withSNSTopic
The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.
- Parameters:
sNSTopic
- The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRetrievalByteRange
The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
- Parameters:
retrievalByteRange
- The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.An error occurs if you specify this field for an inventory retrieval job request.
-
getRetrievalByteRange
The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
- Returns:
- The byte range to retrieve for an archive retrieval. in the form
"StartByteValue-EndByteValue" If not specified, the
whole archive is retrieved. If specified, the byte range must be
megabyte (1024*1024) aligned which means that
StartByteValue must be divisible by 1 MB and
EndByteValue plus 1 must be divisible by 1 MB or be the
end of the archive specified as the archive byte size value minus
1. If RetrievalByteRange is not megabyte aligned, this operation
returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
-
withRetrievalByteRange
The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.
An error occurs if you specify this field for an inventory retrieval job request.
- Parameters:
retrievalByteRange
- The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.An error occurs if you specify this field for an inventory retrieval job request.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInventoryRetrievalParameters
public void setInventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters) Input parameters used for range inventory retrieval.
- Parameters:
inventoryRetrievalParameters
- Input parameters used for range inventory retrieval.
-
getInventoryRetrievalParameters
Input parameters used for range inventory retrieval.
- Returns:
- Input parameters used for range inventory retrieval.
-
withInventoryRetrievalParameters
public JobParameters withInventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters) Input parameters used for range inventory retrieval.
- Parameters:
inventoryRetrievalParameters
- Input parameters used for range inventory retrieval.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-