public class InventoryRetrievalJobDescription extends Object implements Serializable, Cloneable
Describes the options for a range inventory retrieval job.
Constructor and Description |
---|
InventoryRetrievalJobDescription() |
Modifier and Type | Method and Description |
---|---|
InventoryRetrievalJobDescription |
clone() |
boolean |
equals(Object obj) |
String |
getEndDate()
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
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.
|
String |
getLimit()
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
String |
getMarker()
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
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(String endDate)
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
void |
setFormat(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(String limit)
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
void |
setMarker(String marker)
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
void |
setStartDate(String startDate)
The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
InventoryRetrievalJobDescription |
withEndDate(String endDate)
The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date.
|
InventoryRetrievalJobDescription |
withFormat(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(String limit)
Specifies the maximum number of inventory items returned per vault
inventory retrieval request.
|
InventoryRetrievalJobDescription |
withMarker(String marker)
An opaque string that represents where to continue pagination of the
vault inventory retrieval results.
|
InventoryRetrievalJobDescription |
withStartDate(String startDate)
The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date.
|
public void setFormat(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 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(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(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 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(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(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 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(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(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 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(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(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 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(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 String toString()
toString
in class Object
Object.toString()
public InventoryRetrievalJobDescription clone()
Copyright © 2018. All rights reserved.