java.lang.Object
- software.amazon.awssdk.services.iotfleetwise.model.S3Config

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3Config.Builder,S3Config>
```
@Generated("software.amazon.awssdk:codegen")
public final class S3Config
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3Config.Builder,S3Config>
```
The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface S3Config.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bucketArn()`	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
`static S3Config.Builder`	`builder()`
`DataFormat`	`dataFormat()`	Specify the format that files are saved in the Amazon S3 bucket.
`String`	`dataFormatAsString()`	Specify the format that files are saved in the Amazon S3 bucket.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`prefix()`	(Optional) Enter an S3 bucket prefix.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends S3Config.Builder>`	`serializableBuilderClass()`
`StorageCompressionFormat`	`storageCompressionFormat()`	By default, stored data is compressed as a .gzip file.
`String`	`storageCompressionFormatAsString()`	By default, stored data is compressed as a .gzip file.
`S3Config.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
  - bucketArn
```
public final String bucketArn()
```
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon S3 bucket.
  - dataFormat
```
public final DataFormat dataFormat()
```
    Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
    
    Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
    
    JSON - Store data in a standard text-based JSON file format.
    
    If the service returns an enum value that is not available in the current SDK version, dataFormat will return DataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataFormatAsString().
    Returns:
    
    Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
    
    Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
    
    JSON - Store data in a standard text-based JSON file format.
    
    See Also:
    
    DataFormat
  - dataFormatAsString
```
public final String dataFormatAsString()
```
    Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
    
    Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
    
    JSON - Store data in a standard text-based JSON file format.
    
    If the service returns an enum value that is not available in the current SDK version, dataFormat will return DataFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataFormatAsString().
    Returns:
    
    Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.
    
    Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default.
    
    JSON - Store data in a standard text-based JSON file format.
    
    See Also:
    
    DataFormat
  - storageCompressionFormat
```
public final StorageCompressionFormat storageCompressionFormat()
```
    By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
    
    If the service returns an enum value that is not available in the current SDK version, storageCompressionFormat will return StorageCompressionFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageCompressionFormatAsString().
    
    Returns:
    
    By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
    
    See Also:
    
    StorageCompressionFormat
  - storageCompressionFormatAsString
```
public final String storageCompressionFormatAsString()
```
    By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
    
    If the service returns an enum value that is not available in the current SDK version, storageCompressionFormat will return StorageCompressionFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageCompressionFormatAsString().
    
    Returns:
    
    By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
    
    See Also:
    
    StorageCompressionFormat
  - prefix
```
public final String prefix()
```
    (Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
    
    By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
    
    Returns:
    
    (Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
    
    By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
  - toBuilder
```
public S3Config.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<S3Config.Builder,S3Config>
  - builder
```
public static S3Config.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends S3Config.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

Class S3Config

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

bucketArn

dataFormat

dataFormatAsString

storageCompressionFormat

storageCompressionFormatAsString

prefix

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields