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

Interface InventoryConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InventoryConfiguration.Builder,InventoryConfiguration>, SdkBuilder<InventoryConfiguration.Builder,InventoryConfiguration>, SdkPojo

Enclosing class:

InventoryConfiguration

@Mutable
@NotThreadSafe
public static interface InventoryConfiguration.Builder
extends SdkPojo, CopyableBuilder<InventoryConfiguration.Builder,InventoryConfiguration>

Method Summary

Modifier and Type	Method	Description
default InventoryConfiguration.Builder	destination(Consumer<InventoryDestination.Builder> destination)	Contains information about where to publish the inventory results.
InventoryConfiguration.Builder	destination(InventoryDestination destination)	Contains information about where to publish the inventory results.
default InventoryConfiguration.Builder	filter(Consumer<InventoryFilter.Builder> filter)	Specifies an inventory filter.
InventoryConfiguration.Builder	filter(InventoryFilter filter)	Specifies an inventory filter.
InventoryConfiguration.Builder	id(String id)	The ID used to identify the inventory configuration.
InventoryConfiguration.Builder	includedObjectVersions(String includedObjectVersions)	Object versions to include in the inventory list.
InventoryConfiguration.Builder	includedObjectVersions(InventoryIncludedObjectVersions includedObjectVersions)	Object versions to include in the inventory list.
InventoryConfiguration.Builder	isEnabled(Boolean isEnabled)	Specifies whether the inventory is enabled or disabled.
InventoryConfiguration.Builder	optionalFields(Collection<InventoryOptionalField> optionalFields)	Contains the optional fields that are included in the inventory results.
InventoryConfiguration.Builder	optionalFields(InventoryOptionalField... optionalFields)	Contains the optional fields that are included in the inventory results.
InventoryConfiguration.Builder	optionalFieldsWithStrings(String... optionalFields)	Contains the optional fields that are included in the inventory results.
InventoryConfiguration.Builder	optionalFieldsWithStrings(Collection<String> optionalFields)	Contains the optional fields that are included in the inventory results.
default InventoryConfiguration.Builder	schedule(Consumer<InventorySchedule.Builder> schedule)	Specifies the schedule for generating inventory results.
InventoryConfiguration.Builder	schedule(InventorySchedule schedule)	Specifies the schedule for generating inventory results.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

destination

InventoryConfiguration.Builder destination(InventoryDestination destination)

Contains information about where to publish the inventory results.

Parameters:

destination - Contains information about where to publish the inventory results.

Returns:

Returns a reference to this object so that method calls can be chained together.

destination

default InventoryConfiguration.Builder destination(Consumer<InventoryDestination.Builder> destination)

Contains information about where to publish the inventory results.

This is a convenience method that creates an instance of the InventoryDestination.Builder avoiding the need to create one manually via InventoryDestination.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destination(InventoryDestination).

Parameters:

destination - a consumer that will call methods on InventoryDestination.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

destination(InventoryDestination)

isEnabled

InventoryConfiguration.Builder isEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

filter

InventoryConfiguration.Builder filter(InventoryFilter filter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filter

default InventoryConfiguration.Builder filter(Consumer<InventoryFilter.Builder> filter)

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

This is a convenience method that creates an instance of the InventoryFilter.Builder avoiding the need to create one manually via InventoryFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(InventoryFilter).

Parameters:

filter - a consumer that will call methods on InventoryFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

filter(InventoryFilter)

id

InventoryConfiguration.Builder id(String id)

The ID used to identify the inventory configuration.

Parameters:

id - The ID used to identify the inventory configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

includedObjectVersions

InventoryConfiguration.Builder includedObjectVersions(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InventoryIncludedObjectVersions, InventoryIncludedObjectVersions

includedObjectVersions

InventoryConfiguration.Builder includedObjectVersions(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InventoryIncludedObjectVersions, InventoryIncludedObjectVersions

optionalFieldsWithStrings

InventoryConfiguration.Builder optionalFieldsWithStrings(Collection<String> optionalFields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

optionalFieldsWithStrings

InventoryConfiguration.Builder optionalFieldsWithStrings(String... optionalFields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

optionalFields

InventoryConfiguration.Builder optionalFields(Collection<InventoryOptionalField> optionalFields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

optionalFields

InventoryConfiguration.Builder optionalFields(InventoryOptionalField... optionalFields)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

InventoryConfiguration.Builder schedule(InventorySchedule schedule)

Specifies the schedule for generating inventory results.

Parameters:

schedule - Specifies the schedule for generating inventory results.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

default InventoryConfiguration.Builder schedule(Consumer<InventorySchedule.Builder> schedule)

Specifies the schedule for generating inventory results.

This is a convenience method that creates an instance of the InventorySchedule.Builder avoiding the need to create one manually via InventorySchedule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(InventorySchedule).

Parameters:

schedule - a consumer that will call methods on InventorySchedule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schedule(InventorySchedule)