public class InventoryRetrievalJobDescription
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Describes the options for a range inventory retrieval job.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
endDate
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
private java.lang.String |
format
The output format for the vault inventory list, which is set by the
InitiateJob request when initiating a job to retrieve a vault
inventory.
|
private java.lang.String |
limit
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
private java.lang.String |
marker
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
private java.lang.String |
startDate
The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date.
|
Constructor and Description |
---|
InventoryRetrievalJobDescription() |
Modifier and Type | Method and Description |
---|---|
InventoryRetrievalJobDescription |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getEndDate()
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
java.lang.String |
getFormat()
The output format for the vault inventory list, which is set by the
InitiateJob request when initiating a job to retrieve a vault
inventory.
|
java.lang.String |
getLimit()
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
java.lang.String |
getMarker()
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
java.lang.String |
getStartDate()
The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date.
|
int |
hashCode() |
void |
setEndDate(java.lang.String endDate)
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
void |
setFormat(java.lang.String format)
The output format for the vault inventory list, which is set by the
InitiateJob request when initiating a job to retrieve a vault
inventory.
|
void |
setLimit(java.lang.String limit)
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
void |
setMarker(java.lang.String marker)
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
void |
setStartDate(java.lang.String startDate)
The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
InventoryRetrievalJobDescription |
withEndDate(java.lang.String endDate)
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
InventoryRetrievalJobDescription |
withFormat(java.lang.String format)
The output format for the vault inventory list, which is set by the
InitiateJob request when initiating a job to retrieve a vault
inventory.
|
InventoryRetrievalJobDescription |
withLimit(java.lang.String limit)
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
InventoryRetrievalJobDescription |
withMarker(java.lang.String marker)
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
InventoryRetrievalJobDescription |
withStartDate(java.lang.String startDate)
The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date.
|
private java.lang.String format
The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are "CSV" and "JSON".
private java.lang.String startDate
The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
private java.lang.String endDate
The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
private java.lang.String limit
Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
private java.lang.String marker
An opaque string that represents where to continue pagination of the
vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items. If there
are no more inventory items, this value is null
. For more
information, see Range Inventory Retrieval.
public void setFormat(java.lang.String format)
The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are "CSV" and "JSON".
format
- The output format for the vault inventory list, which is set by
the InitiateJob request when initiating a job to retrieve a
vault inventory. Valid values are "CSV" and "JSON".public java.lang.String getFormat()
The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are "CSV" and "JSON".
public InventoryRetrievalJobDescription withFormat(java.lang.String format)
The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are "CSV" and "JSON".
format
- The output format for the vault inventory list, which is set by
the InitiateJob request when initiating a job to retrieve a
vault inventory. Valid values are "CSV" and "JSON".public void setStartDate(java.lang.String startDate)
The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
startDate
- The start of the date range in UTC for vault inventory retrieval
that includes archives created on or after this date. A string
representation of ISO 8601 date format, for example,
2013-03-20T17:03:43Z.public java.lang.String getStartDate()
The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
public InventoryRetrievalJobDescription withStartDate(java.lang.String startDate)
The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
startDate
- The start of the date range in UTC for vault inventory retrieval
that includes archives created on or after this date. A string
representation of ISO 8601 date format, for example,
2013-03-20T17:03:43Z.public void setEndDate(java.lang.String endDate)
The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
endDate
- The end of the date range in UTC for vault inventory retrieval
that includes archives created before this date. A string
representation of ISO 8601 date format, for example,
2013-03-20T17:03:43Z.public java.lang.String getEndDate()
The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
public InventoryRetrievalJobDescription withEndDate(java.lang.String endDate)
The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.
endDate
- The end of the date range in UTC for vault inventory retrieval
that includes archives created before this date. A string
representation of ISO 8601 date format, for example,
2013-03-20T17:03:43Z.public void setLimit(java.lang.String limit)
Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
limit
- Specifies the maximum number of inventory items returned per vault
inventory retrieval request. This limit is set when initiating the
job with the a InitiateJob request.public java.lang.String getLimit()
Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
public InventoryRetrievalJobDescription withLimit(java.lang.String limit)
Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.
limit
- Specifies the maximum number of inventory items returned per vault
inventory retrieval request. This limit is set when initiating the
job with the a InitiateJob request.public void setMarker(java.lang.String marker)
An opaque string that represents where to continue pagination of the
vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items. If there
are no more inventory items, this value is null
. For more
information, see Range Inventory Retrieval.
marker
- An opaque string that represents where to continue pagination of
the vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items.
If there are no more inventory items, this value is
null
. For more information, see Range Inventory Retrieval.public java.lang.String getMarker()
An opaque string that represents where to continue pagination of the
vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items. If there
are no more inventory items, this value is null
. For more
information, see Range Inventory Retrieval.
null
. For more information, see Range Inventory Retrieval.public InventoryRetrievalJobDescription withMarker(java.lang.String marker)
An opaque string that represents where to continue pagination of the
vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items. If there
are no more inventory items, this value is null
. For more
information, see Range Inventory Retrieval.
marker
- An opaque string that represents where to continue pagination of
the vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items.
If there are no more inventory items, this value is
null
. For more information, see 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 InventoryRetrievalJobDescription clone()
clone
in class java.lang.Object