software.amazon.awssdk.services.glacier.model

Class InventoryRetrievalJobDescription

java.lang.Object

software.amazon.awssdk.services.glacier.model.InventoryRetrievalJobDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InventoryRetrievalJobDescription.Builder,InventoryRetrievalJobDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class InventoryRetrievalJobDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InventoryRetrievalJobDescription.Builder,InventoryRetrievalJobDescription>

Describes the options for a range inventory retrieval job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InventoryRetrievalJobDescription.Builder

Method Summary

Modifier and Type	Method and Description
static InventoryRetrievalJobDescription.Builder	builder()
String	endDate() The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	limit() The maximum number of inventory items returned per vault inventory retrieval request.
String	marker() An opaque string that represents where to continue pagination of the vault inventory retrieval results.
List<SdkField<?>>	sdkFields()
static Class<? extends InventoryRetrievalJobDescription.Builder>	serializableBuilderClass()
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.
InventoryRetrievalJobDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

format

public final 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.

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.

startDate

public final 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.

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.

endDate

public final 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.

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.

limit

public final 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.

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.

marker

public final 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.

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.

toBuilder

public InventoryRetrievalJobDescription.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InventoryRetrievalJobDescription.Builder,InventoryRetrievalJobDescription>

Returns:

a builder for type T

builder

public static InventoryRetrievalJobDescription.Builder builder()

serializableBuilderClass

public static Class<? extends InventoryRetrievalJobDescription.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.