Class InventoryRetrievalJobDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InventoryRetrievalJobDescription.Builder,
InventoryRetrievalJobDescription>
Describes the options for a range inventory retrieval job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
endDate()
The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
limit()
The maximum number of inventory items returned per vault inventory retrieval request.final String
marker()
An opaque string that represents where to continue pagination of the vault inventory retrieval results.static Class
<? extends InventoryRetrievalJobDescription.Builder> final String
The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
andJSON
.- 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
andJSON
.
-
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
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
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
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
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 interfaceToCopyableBuilder<InventoryRetrievalJobDescription.Builder,
InventoryRetrievalJobDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-