@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.
Modifier and Type | Class and Description |
---|---|
static interface |
InventoryRetrievalJobDescription.Builder |
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.
|
copy
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
.
CSV
and JSON
.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
.
2013-03-20T17:03:43Z
.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
.
2013-03-20T17:03:43Z
.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.
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.
null
. For more information, see Range Inventory Retrieval.public InventoryRetrievalJobDescription.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<InventoryRetrievalJobDescription.Builder,InventoryRetrievalJobDescription>
public static InventoryRetrievalJobDescription.Builder builder()
public static Class<? extends InventoryRetrievalJobDescription.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.