InventoryS3BucketDestination (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.services.s3.model.InventoryS3BucketDestination

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InventoryS3BucketDestination.Builder,InventoryS3BucketDestination>, Serializable
```
@Generated(value="com.ibm.cos.v2:codegen")
public final class InventoryS3BucketDestination
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InventoryS3BucketDestination.Builder,InventoryS3BucketDestination>
```
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InventoryS3BucketDestination.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InventoryS3BucketDestination.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accountId()` The account ID that owns the destination S3 bucket.
`String`	`bucket()` The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
`static InventoryS3BucketDestination.Builder`	`builder()`
`InventoryEncryption`	`encryption()` Contains the type of server-side encryption used to encrypt the inventory results.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`InventoryFormat`	`format()` Specifies the output format of the inventory results.
`String`	`formatAsString()` Specifies the output format of the inventory results.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`prefix()` The prefix that is prepended to all inventory results.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InventoryS3BucketDestination.Builder>`	`serializableBuilderClass()`
`InventoryS3BucketDestination.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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 com.ibm.cos.v2.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - accountId
```
public final String accountId()
```
    The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
    
    Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
    
    Returns:
    
    The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
    
    Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
  - bucket
```
public final String bucket()
```
    The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
  - format
```
public final InventoryFormat format()
```
    Specifies the output format of the inventory results.
    
    If the service returns an enum value that is not available in the current SDK version, format will return InventoryFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    Specifies the output format of the inventory results.
    
    See Also:
    
    InventoryFormat
  - formatAsString
```
public final String formatAsString()
```
    Specifies the output format of the inventory results.
    
    If the service returns an enum value that is not available in the current SDK version, format will return InventoryFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    Specifies the output format of the inventory results.
    
    See Also:
    
    InventoryFormat
  - prefix
```
public final String prefix()
```
    The prefix that is prepended to all inventory results.
    
    Returns:
    
    The prefix that is prepended to all inventory results.
  - encryption
```
public final InventoryEncryption encryption()
```
    Contains the type of server-side encryption used to encrypt the inventory results.
    
    Returns:
    
    Contains the type of server-side encryption used to encrypt the inventory results.
  - toBuilder
```
public InventoryS3BucketDestination.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InventoryS3BucketDestination.Builder,InventoryS3BucketDestination>
    
    Returns:
    
    a builder for type T
  - builder
```
public static InventoryS3BucketDestination.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InventoryS3BucketDestination.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo
    
    Returns:
    
    The mapping between the field name and its corresponding field.

Class InventoryS3BucketDestination

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

Method Detail

accountId

bucket

format

formatAsString

prefix

encryption

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField