Package software.amazon.awssdk.services.lookoutmetrics.model

Class S3SourceConfig

java.lang.Object

software.amazon.awssdk.services.lookoutmetrics.model.S3SourceConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3SourceConfig.Builder,S3SourceConfig>

@Generated("software.amazon.awssdk:codegen")
public final class S3SourceConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3SourceConfig.Builder,S3SourceConfig>

Contains information about the configuration of the S3 bucket that contains source files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3SourceConfig.Builder

Method Summary

Modifier and Type	Method	Description
static S3SourceConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FileFormatDescriptor	fileFormatDescriptor()	Contains information about a source file's formatting.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHistoricalDataPathList()	For responses, this returns true if the service returned a value for the HistoricalDataPathList property.
boolean	hasTemplatedPathList()	For responses, this returns true if the service returned a value for the TemplatedPathList property.
List<String>	historicalDataPathList()	A list of paths to the historical data files.
String	roleArn()	The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends S3SourceConfig.Builder>	serializableBuilderClass()
List<String>	templatedPathList()	A list of templated paths to the source files.
S3SourceConfig.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

roleArn

public final String roleArn()

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

Returns:

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

hasTemplatedPathList

public final boolean hasTemplatedPathList()

For responses, this returns true if the service returned a value for the TemplatedPathList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

templatedPathList

public final List<String> templatedPathList()

A list of templated paths to the source files.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTemplatedPathList() method.

Returns:

A list of templated paths to the source files.

hasHistoricalDataPathList

public final boolean hasHistoricalDataPathList()

For responses, this returns true if the service returned a value for the HistoricalDataPathList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

historicalDataPathList

public final List<String> historicalDataPathList()

A list of paths to the historical data files.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHistoricalDataPathList() method.

Returns:

A list of paths to the historical data files.

fileFormatDescriptor

public final FileFormatDescriptor fileFormatDescriptor()

Contains information about a source file's formatting.

Returns:

Contains information about a source file's formatting.

toBuilder

public S3SourceConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3SourceConfig.Builder,S3SourceConfig>

builder

public static S3SourceConfig.Builder builder()

serializableBuilderClass

public static Class<? extends S3SourceConfig.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