software.amazon.awscdk.services.s3

Class Inventory.Builder

java.lang.Object

software.amazon.awscdk.services.s3.Inventory.Builder

Enclosing interface:

Inventory

public static final class Inventory.Builder
extends java.lang.Object

A builder for Inventory

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Inventory	build() Builds the configured instance.
Inventory.Builder	destination(InventoryDestination destination) Sets the value of Inventory.getDestination()
Inventory.Builder	enabled(java.lang.Boolean enabled) Sets the value of Inventory.getEnabled()
Inventory.Builder	format(InventoryFormat format) Sets the value of Inventory.getFormat()
Inventory.Builder	frequency(InventoryFrequency frequency) Sets the value of Inventory.getFrequency()
Inventory.Builder	includeObjectVersions(InventoryObjectVersion includeObjectVersions) Sets the value of Inventory.getIncludeObjectVersions()
Inventory.Builder	inventoryId(java.lang.String inventoryId) Sets the value of Inventory.getInventoryId()
Inventory.Builder	objectsPrefix(java.lang.String objectsPrefix) Sets the value of Inventory.getObjectsPrefix()
Inventory.Builder	optionalFields(java.util.List<java.lang.String> optionalFields) Sets the value of Inventory.getOptionalFields()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

destination

public Inventory.Builder destination(InventoryDestination destination)

Sets the value of Inventory.getDestination()

Parameters:

destination - The destination of the inventory. This parameter is required.

Returns:

this

enabled

public Inventory.Builder enabled(java.lang.Boolean enabled)

Sets the value of Inventory.getEnabled()

Parameters:

enabled - Whether the inventory is enabled or disabled.

Returns:

this

format

public Inventory.Builder format(InventoryFormat format)

Sets the value of Inventory.getFormat()

Parameters:

format - The format of the inventory.

Returns:

this

frequency

public Inventory.Builder frequency(InventoryFrequency frequency)

Sets the value of Inventory.getFrequency()

Parameters:

frequency - Frequency at which the inventory should be generated.

Returns:

this

includeObjectVersions

public Inventory.Builder includeObjectVersions(InventoryObjectVersion includeObjectVersions)

Sets the value of Inventory.getIncludeObjectVersions()

Parameters:

includeObjectVersions - If the inventory should contain all the object versions or only the current one.

Returns:

this

inventoryId

public Inventory.Builder inventoryId(java.lang.String inventoryId)

Sets the value of Inventory.getInventoryId()

Parameters:

inventoryId - The inventory configuration ID.

Returns:

this

objectsPrefix

public Inventory.Builder objectsPrefix(java.lang.String objectsPrefix)

Sets the value of Inventory.getObjectsPrefix()

Parameters:

objectsPrefix - The inventory will only include objects that meet the prefix filter criteria.

Returns:

this

optionalFields

public Inventory.Builder optionalFields(java.util.List<java.lang.String> optionalFields)

Sets the value of Inventory.getOptionalFields()

Parameters:

optionalFields - A list of optional fields to be included in the inventory result.

Returns:

this

build

public Inventory build()

Builds the configured instance.

Returns:

a new instance of Inventory

Throws:

java.lang.NullPointerException - if any required attribute was not provided