Class InventoryRetrievalJobDescription
- java.lang.Object
-
- com.amazonaws.services.glacier.model.InventoryRetrievalJobDescription
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class InventoryRetrievalJobDescription extends Object implements Serializable, Cloneable
Describes the options for a range inventory retrieval job.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description InventoryRetrievalJobDescription()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Method Detail
-
setFormat
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".
- 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
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".
- 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
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".
- 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
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.
- 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
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.
- 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
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.
- 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
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.
- 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
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.
- 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
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.
- 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
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.
- 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
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.
- 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
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.
- 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
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.- 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
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.- 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
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.- 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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public InventoryRetrievalJobDescription clone()
-
-