@Generated(value="software.amazon.awssdk:codegen") public final class InventoryConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InventoryConfiguration.Builder,InventoryConfiguration>
Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.
Modifier and Type | Class and Description |
---|---|
static interface |
InventoryConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
static InventoryConfiguration.Builder |
builder() |
InventoryDestination |
destination()
Contains information about where to publish the inventory results.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
InventoryFilter |
filter()
Specifies an inventory filter.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasOptionalFields()
For responses, this returns true if the service returned a value for the OptionalFields property.
|
String |
id()
The ID used to identify the inventory configuration.
|
InventoryIncludedObjectVersions |
includedObjectVersions()
Object versions to include in the inventory list.
|
String |
includedObjectVersionsAsString()
Object versions to include in the inventory list.
|
Boolean |
isEnabled()
Specifies whether the inventory is enabled or disabled.
|
List<InventoryOptionalField> |
optionalFields()
Contains the optional fields that are included in the inventory results.
|
List<String> |
optionalFieldsAsStrings()
Contains the optional fields that are included in the inventory results.
|
InventorySchedule |
schedule()
Specifies the schedule for generating inventory results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends InventoryConfiguration.Builder> |
serializableBuilderClass() |
InventoryConfiguration.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final InventoryDestination destination()
Contains information about where to publish the inventory results.
public final Boolean isEnabled()
Specifies whether the inventory is enabled or disabled. If set to True
, an inventory list is
generated. If set to False
, no inventory list is generated.
True
, an inventory list is
generated. If set to False
, no inventory list is generated.public final InventoryFilter filter()
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
public final String id()
The ID used to identify the inventory configuration.
public final InventoryIncludedObjectVersions includedObjectVersions()
Object versions to include in the inventory list. If set to All
, the list includes all the object
versions, which adds the version-related fields VersionId
, IsLatest
, and
DeleteMarker
to the list. If set to Current
, the list does not contain these
version-related fields.
If the service returns an enum value that is not available in the current SDK version,
includedObjectVersions
will return InventoryIncludedObjectVersions.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from includedObjectVersionsAsString()
.
All
, the list includes all the
object versions, which adds the version-related fields VersionId
, IsLatest
, and
DeleteMarker
to the list. If set to Current
, the list does not contain these
version-related fields.InventoryIncludedObjectVersions
public final String includedObjectVersionsAsString()
Object versions to include in the inventory list. If set to All
, the list includes all the object
versions, which adds the version-related fields VersionId
, IsLatest
, and
DeleteMarker
to the list. If set to Current
, the list does not contain these
version-related fields.
If the service returns an enum value that is not available in the current SDK version,
includedObjectVersions
will return InventoryIncludedObjectVersions.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from includedObjectVersionsAsString()
.
All
, the list includes all the
object versions, which adds the version-related fields VersionId
, IsLatest
, and
DeleteMarker
to the list. If set to Current
, the list does not contain these
version-related fields.InventoryIncludedObjectVersions
public final List<InventoryOptionalField> optionalFields()
Contains the optional fields that are included in the inventory results.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasOptionalFields()
method.
public final boolean hasOptionalFields()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> optionalFieldsAsStrings()
Contains the optional fields that are included in the inventory results.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasOptionalFields()
method.
public final InventorySchedule schedule()
Specifies the schedule for generating inventory results.
public InventoryConfiguration.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<InventoryConfiguration.Builder,InventoryConfiguration>
public static InventoryConfiguration.Builder builder()
public static Class<? extends InventoryConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.