InventoryConfiguration (IBM COS SDK for Java 2.13.6 API)

java.lang.Object
- com.ibm.cloud.objectstorage.services.s3.model.inventory.InventoryConfiguration

All Implemented Interfaces:

Serializable
```
public class InventoryConfiguration
extends Object
implements Serializable
```
Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

InventoryConfiguration()

Constructors
Constructor and Description
`InventoryConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOptionalField(InventoryOptionalField optionalField)` Add a field to the list of optional fields that are included in the inventory results.
`void`	`addOptionalField(String optionalField)` Add a field to the list of optional fields that are included in the inventory results.
`InventoryDestination`	`getDestination()` Returns the `InventoryDestination` that contains information about where to publish the inventory results.
`String`	`getId()` Returns the ID used to identify the inventory configuration.
`String`	`getIncludedObjectVersions()` Returns which object version(s) to included in the inventory results.
`InventoryFilter`	`getInventoryFilter()` Returns the inventoryFilter used to describe a set of objects to include in inventory results.
`List<String>`	`getOptionalFields()` Returns the optional fields that are included in the inventory results.
`InventorySchedule`	`getSchedule()` Returns the schedule for generating inventory results.
`Boolean`	`isEnabled()` Returns true if the inventory is enabled or false if inventory is disabled.
`void`	`setDestination(InventoryDestination destination)` Sets the `InventoryDestination` that contains information about where to publish the inventory results.
`void`	`setEnabled(Boolean enabled)` Sets the value whether the inventory is enabled or disabled.
`void`	`setId(String id)` Sets the ID used to identify the inventory configuration.
`void`	`setIncludedObjectVersions(InventoryIncludedObjectVersions includedObjectVersions)` Sets which object version(s) to included in the inventory results.
`void`	`setIncludedObjectVersions(String includedObjectVersions)` Sets which object version(s) to included in the inventory results.
`void`	`setInventoryFilter(InventoryFilter inventoryFilter)` Sets the inventoryFilter used to describe a set of objects to include in inventory results.
`void`	`setOptionalFields(List<String> optionalFields)` Sets the optional fields that are included in the inventory results.
`void`	`setSchedule(InventorySchedule schedule)` Sets the schedule for generating inventory results.
`InventoryConfiguration`	`withDestination(InventoryDestination destination)` Sets the `InventoryDestination` that contains information about where to publish the inventory results and returns this object for method chaining.
`InventoryConfiguration`	`withEnabled(Boolean enabled)` Sets the value whether the inventory is enabled or disabled and returns this object for method chaining.
`InventoryConfiguration`	`withFilter(InventoryFilter inventoryFilter)` Sets the inventoryFilter used to describe a set of objects to include in inventory results.
`InventoryConfiguration`	`withId(String id)` Sets the ID used to identify the inventory configuration and returns this object for method chaining.
`InventoryConfiguration`	`withIncludedObjectVersions(InventoryIncludedObjectVersions includedObjectVersions)` Sets which object version(s) to included in the inventory results and returns this object for method chaining.
`InventoryConfiguration`	`withIncludedObjectVersions(String includedObjectVersions)` Sets which object version(s) to included in the inventory results and returns this object for method chaining.
`InventoryConfiguration`	`withOptionalFields(List<String> optionalFields)` Sets the optional fields that are included in the inventory results.
`InventoryConfiguration`	`withSchedule(InventorySchedule schedule)` Returns the schedule for generating inventory results and returns `InventoryConfiguration` object for method chaining.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - InventoryConfiguration
```
public InventoryConfiguration()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns the ID used to identify the inventory configuration.
  - setId
```
public void setId(String id)
```
    Sets the ID used to identify the inventory configuration.
  - withId
```
public InventoryConfiguration withId(String id)
```
    Sets the ID used to identify the inventory configuration and returns this object for method chaining.
  - getDestination
```
public InventoryDestination getDestination()
```
    Returns the InventoryDestination that contains information about where to publish the inventory results.
  - setDestination
```
public void setDestination(InventoryDestination destination)
```
    Sets the InventoryDestination that contains information about where to publish the inventory results.
  - withDestination
```
public InventoryConfiguration withDestination(InventoryDestination destination)
```
    Sets the InventoryDestination that contains information about where to publish the inventory results and returns this object for method chaining.
  - isEnabled
```
public Boolean isEnabled()
```
    Returns true if the inventory is enabled or false if inventory is disabled.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Sets the value whether the inventory is enabled or disabled. The value true indicates the inventory is enabled and false indicates the inventory is disabled.
  - withEnabled
```
public InventoryConfiguration withEnabled(Boolean enabled)
```
    Sets the value whether the inventory is enabled or disabled and returns this object for method chaining. The value true indicates the inventory is enabled and false indicates the inventory is disabled.
  - getInventoryFilter
```
public InventoryFilter getInventoryFilter()
```
    Returns the inventoryFilter used to describe a set of objects to include in inventory results.
  - setInventoryFilter
```
public void setInventoryFilter(InventoryFilter inventoryFilter)
```
    Sets the inventoryFilter used to describe a set of objects to include in inventory results.
  - withFilter
```
public InventoryConfiguration withFilter(InventoryFilter inventoryFilter)
```
    Sets the inventoryFilter used to describe a set of objects to include in inventory results. The InventoryConfiguration object is returned for method chaining.
  - getIncludedObjectVersions
```
public String getIncludedObjectVersions()
```
    Returns which object version(s) to included in the inventory results.
  - setIncludedObjectVersions
```
public void setIncludedObjectVersions(String includedObjectVersions)
```
    Sets which object version(s) to included in the inventory results.
  - withIncludedObjectVersions
```
public InventoryConfiguration withIncludedObjectVersions(String includedObjectVersions)
```
    Sets which object version(s) to included in the inventory results and returns this object for method chaining.
  - setIncludedObjectVersions
```
public void setIncludedObjectVersions(InventoryIncludedObjectVersions includedObjectVersions)
```
    Sets which object version(s) to included in the inventory results.
  - withIncludedObjectVersions
```
public InventoryConfiguration withIncludedObjectVersions(InventoryIncludedObjectVersions includedObjectVersions)
```
    Sets which object version(s) to included in the inventory results and returns this object for method chaining.
  - getOptionalFields
```
public List<String> getOptionalFields()
```
    Returns the optional fields that are included in the inventory results.
  - setOptionalFields
```
public void setOptionalFields(List<String> optionalFields)
```
    Sets the optional fields that are included in the inventory results.
  - withOptionalFields
```
public InventoryConfiguration withOptionalFields(List<String> optionalFields)
```
    Sets the optional fields that are included in the inventory results. The InventoryConfiguration object is returned for method chaining.
  - addOptionalField
```
public void addOptionalField(String optionalField)
```
    Add a field to the list of optional fields that are included in the inventory results.
  - addOptionalField
```
public void addOptionalField(InventoryOptionalField optionalField)
```
    Add a field to the list of optional fields that are included in the inventory results.
  - getSchedule
```
public InventorySchedule getSchedule()
```
    Returns the schedule for generating inventory results.
  - setSchedule
```
public void setSchedule(InventorySchedule schedule)
```
    Sets the schedule for generating inventory results.
  - withSchedule
```
public InventoryConfiguration withSchedule(InventorySchedule schedule)
```
    Returns the schedule for generating inventory results and returns InventoryConfiguration object for method chaining.

Class InventoryConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InventoryConfiguration

Method Detail

getId

setId

withId

getDestination

setDestination

withDestination

isEnabled

setEnabled

withEnabled

getInventoryFilter

setInventoryFilter

withFilter

getIncludedObjectVersions

setIncludedObjectVersions

withIncludedObjectVersions

setIncludedObjectVersions

withIncludedObjectVersions

getOptionalFields

setOptionalFields

withOptionalFields

addOptionalField

addOptionalField

getSchedule

setSchedule

withSchedule