software.amazon.awssdk.services.glacier.model

Class InventoryRetrievalJobInput

java.lang.Object

software.amazon.awssdk.services.glacier.model.InventoryRetrievalJobInput

All Implemented Interfaces:

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

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

Provides options for specifying a range inventory retrieval job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InventoryRetrievalJobInput.Builder

Method Summary

Modifier and Type	Method and Description
static InventoryRetrievalJobInput.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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	limit() Specifies 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 InventoryRetrievalJobInput.Builder>	serializableBuilderClass()
String	startDate() The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date.
InventoryRetrievalJobInput.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

startDate

public String startDate()

The start of the date range in 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 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 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 String limit()

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

Returns:

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

marker

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

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.

toBuilder

public InventoryRetrievalJobInput.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<InventoryRetrievalJobInput.Builder,InventoryRetrievalJobInput>

Returns:

a builder for type T

builder

public static InventoryRetrievalJobInput.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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