InventoryRetrievalJobDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glacier.model.InventoryRetrievalJobDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InventoryRetrievalJobDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the options for a range inventory retrieval job.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

InventoryRetrievalJobDescription()

Constructors
Constructor and Description
`InventoryRetrievalJobDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` 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 Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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)` 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 Universal Coordinated Time (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)` 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 Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InventoryRetrievalJobDescription
```
public InventoryRetrievalJobDescription()
```
- 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 Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
    
    Parameters:
    
    startDate - The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
  - getStartDate
```
public String getStartDate()
```
    The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
    
    Returns:
    
    The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
  - withStartDate
```
public InventoryRetrievalJobDescription withStartDate(String startDate)
```
    The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
    
    Parameters:
    
    startDate - The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the 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. This value should be a string in the 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. This value should be a string in the 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. This value should be a string in the 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. This value should be a string in the 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. This value should be a string in the 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. This value should be a string in the 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)
```
    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 - 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()
```
    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:
    
    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)
```
    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 - 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 is null. 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 is null. 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 class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public InventoryRetrievalJobDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class InventoryRetrievalJobDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InventoryRetrievalJobDescription

Method Detail

setFormat

getFormat

withFormat

setStartDate

getStartDate

withStartDate

setEndDate

getEndDate

withEndDate

setLimit

getLimit

withLimit

setMarker

getMarker

withMarker

toString

equals

hashCode

clone

marshall