Package software.amazon.awssdk.services.s3.model

Class InventoryConfiguration

java.lang.Object

software.amazon.awssdk.services.s3.model.InventoryConfiguration

All Implemented Interfaces:

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

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

Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InventoryConfiguration.Builder

Method Summary

Modifier and Type	Method	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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InventoryConfiguration.Builder>	serializableBuilderClass()
InventoryConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

destination

public final InventoryDestination destination()

Contains information about where to publish the inventory results.

Returns:

Contains information about where to publish the inventory results.

isEnabled

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.

Returns:

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.

filter

public final InventoryFilter filter()

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

Returns:

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

id

public final String id()

The ID used to identify the inventory configuration.

Returns:

The ID used to identify the inventory configuration.

includedObjectVersions

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().

Returns:

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.

See Also:

InventoryIncludedObjectVersions

includedObjectVersionsAsString

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().

Returns:

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.

See Also:

InventoryIncludedObjectVersions

optionalFields

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.

Returns:

Contains the optional fields that are included in the inventory results.

hasOptionalFields

public final boolean hasOptionalFields()

For responses, this returns true if the service returned a value for the OptionalFields property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

optionalFieldsAsStrings

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.

Returns:

Contains the optional fields that are included in the inventory results.

schedule

public final InventorySchedule schedule()

Specifies the schedule for generating inventory results.

Returns:

Specifies the schedule for generating inventory results.

toBuilder

public InventoryConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InventoryConfiguration.Builder,InventoryConfiguration>

builder

public static InventoryConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends InventoryConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo