Class InventoryRetrievalJobDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Describes the options for a range inventory retrieval job.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory.getLimit()
Specifies the maximum number of inventory items returned per vault inventory retrieval request.An opaque string that represents where to continue pagination of the vault inventory retrieval results.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
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
Specifies the maximum number of inventory items returned per vault inventory retrieval request.void
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.toString()
Returns a string representation of this object; useful for testing and debugging.withEndDate
(String endDate) The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.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.Specifies the maximum number of inventory items returned per vault inventory retrieval request.withMarker
(String marker) An opaque string that represents where to continue pagination of the vault inventory retrieval results.withStartDate
(String startDate) The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date.
-
Constructor Details
-
InventoryRetrievalJobDescription
public InventoryRetrievalJobDescription()
-
-
Method Details
-
setFormat
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".
- Parameters:
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".
-
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".
- Returns:
- 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".
-
withFormat
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".
- Parameters:
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".- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartDate
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withStartDate
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEndDate
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withEndDate
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withLimit
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
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.- Parameters:
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 isnull
. For more information, see Range Inventory Retrieval.
-
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.- Returns:
- 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.
-
withMarker
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.- Parameters:
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 isnull
. For more information, see 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
-