public class JobParameters
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Provides options for defining a job.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
archiveId
The ID of the archive that you want to retrieve.
|
private java.lang.String |
description
The optional description for the job.
|
private java.lang.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.
|
private InventoryRetrievalJobInput |
inventoryRetrievalParameters
Input parameters used for range inventory retrieval.
|
private java.lang.String |
retrievalByteRange
The byte range to retrieve for an archive retrieval.
|
private java.lang.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.
|
private java.lang.String |
type
The job type.
|
Constructor and Description |
---|
JobParameters()
Default constructor for JobParameters object.
|
JobParameters(java.lang.String format,
java.lang.String type,
java.lang.String archiveId,
java.lang.String description)
Constructs a new JobParameters object.
|
Modifier and Type | Method and Description |
---|---|
JobParameters |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getArchiveId()
The ID of the archive that you want to retrieve.
|
java.lang.String |
getDescription()
The optional description for the job.
|
java.lang.String |
getFormat()
When initiating a job to retrieve a vault inventory, you can optionally
add this parameter to your request to specify the output format.
|
InventoryRetrievalJobInput |
getInventoryRetrievalParameters()
Input parameters used for range inventory retrieval.
|
java.lang.String |
getRetrievalByteRange()
The byte range to retrieve for an archive retrieval.
|
java.lang.String |
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.
|
java.lang.String |
getType()
The job type.
|
int |
hashCode() |
void |
setArchiveId(java.lang.String archiveId)
The ID of the archive that you want to retrieve.
|
void |
setDescription(java.lang.String description)
The optional description for the job.
|
void |
setFormat(java.lang.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.
|
void |
setInventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
|
void |
setRetrievalByteRange(java.lang.String retrievalByteRange)
The byte range to retrieve for an archive retrieval.
|
void |
setSNSTopic(java.lang.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 |
setType(java.lang.String type)
The job type.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
JobParameters |
withArchiveId(java.lang.String archiveId)
The ID of the archive that you want to retrieve.
|
JobParameters |
withDescription(java.lang.String description)
The optional description for the job.
|
JobParameters |
withFormat(java.lang.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.
|
JobParameters |
withInventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
|
JobParameters |
withRetrievalByteRange(java.lang.String retrievalByteRange)
The byte range to retrieve for an archive retrieval.
|
JobParameters |
withSNSTopic(java.lang.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.
|
JobParameters |
withType(java.lang.String type)
The job type.
|
private java.lang.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. 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".
private java.lang.String 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".
private java.lang.String archiveId
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.
private java.lang.String 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.
private java.lang.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 specified topic publishes the notification to its subscribers. The SNS topic must exist.
private java.lang.String 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.
private InventoryRetrievalJobInput inventoryRetrievalParameters
Input parameters used for range inventory retrieval.
public JobParameters()
public JobParameters(java.lang.String format, java.lang.String type, java.lang.String archiveId, java.lang.String description)
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 if Type
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.public void setFormat(java.lang.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. 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".
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".public java.lang.String 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".
public JobParameters withFormat(java.lang.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. 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".
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".public void setType(java.lang.String 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".
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".public java.lang.String 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".
public JobParameters withType(java.lang.String 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".
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".public void setArchiveId(java.lang.String archiveId)
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.
archiveId
- 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.public java.lang.String 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.
Type
is set to archive-retrieval.
An error occurs if you specify this request parameter for an
inventory retrieval job request.public JobParameters withArchiveId(java.lang.String archiveId)
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.
archiveId
- 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.public void setDescription(java.lang.String 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.
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.public java.lang.String 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.
public JobParameters withDescription(java.lang.String 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.
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.public void setSNSTopic(java.lang.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 specified topic publishes the notification to its subscribers. The SNS topic must exist.
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.public java.lang.String 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.
public JobParameters withSNSTopic(java.lang.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 specified topic publishes the notification to its subscribers. The SNS topic must exist.
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.public void setRetrievalByteRange(java.lang.String 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.
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.
public java.lang.String 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.
An error occurs if you specify this field for an inventory retrieval job request.
public JobParameters withRetrievalByteRange(java.lang.String 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.
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.
public void setInventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
inventoryRetrievalParameters
- Input parameters used for range inventory retrieval.public InventoryRetrievalJobInput getInventoryRetrievalParameters()
Input parameters used for range inventory retrieval.
public JobParameters withInventoryRetrievalParameters(InventoryRetrievalJobInput inventoryRetrievalParameters)
Input parameters used for range inventory retrieval.
inventoryRetrievalParameters
- Input parameters used for range inventory retrieval.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public JobParameters clone()
clone
in class java.lang.Object