software.amazon.awssdk.services.appflow.model

Class PrefixConfig

java.lang.Object

software.amazon.awssdk.services.appflow.model.PrefixConfig

All Implemented Interfaces:

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

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

Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PrefixConfig.Builder

Method Summary

Modifier and Type	Method and Description
static PrefixConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPathPrefixHierarchy() For responses, this returns true if the service returned a value for the PathPrefixHierarchy property.
List<PathPrefix>	pathPrefixHierarchy() Specifies whether the destination file path includes either or both of the following elements:
List<String>	pathPrefixHierarchyAsStrings() Specifies whether the destination file path includes either or both of the following elements:
PrefixFormat	prefixFormat() Determines the level of granularity for the date and time that's included in the prefix.
String	prefixFormatAsString() Determines the level of granularity for the date and time that's included in the prefix.
PrefixType	prefixType() Determines the format of the prefix, and whether it applies to the file name, file path, or both.
String	prefixTypeAsString() Determines the format of the prefix, and whether it applies to the file name, file path, or both.
List<SdkField<?>>	sdkFields()
static Class<? extends PrefixConfig.Builder>	serializableBuilderClass()
PrefixConfig.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

prefixType

public final PrefixType prefixType()

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

If the service returns an enum value that is not available in the current SDK version, prefixType will return PrefixType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from prefixTypeAsString().

Returns:

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

See Also:

PrefixType

prefixTypeAsString

public final String prefixTypeAsString()

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

If the service returns an enum value that is not available in the current SDK version, prefixType will return PrefixType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from prefixTypeAsString().

Returns:

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

See Also:

PrefixType

prefixFormat

public final PrefixFormat prefixFormat()

Determines the level of granularity for the date and time that's included in the prefix.

If the service returns an enum value that is not available in the current SDK version, prefixFormat will return PrefixFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from prefixFormatAsString().

Returns:

Determines the level of granularity for the date and time that's included in the prefix.

See Also:

PrefixFormat

prefixFormatAsString

public final String prefixFormatAsString()

Determines the level of granularity for the date and time that's included in the prefix.

If the service returns an enum value that is not available in the current SDK version, prefixFormat will return PrefixFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from prefixFormatAsString().

Returns:

Determines the level of granularity for the date and time that's included in the prefix.

See Also:

PrefixFormat

pathPrefixHierarchy

public final List<PathPrefix> pathPrefixHierarchy()

Specifies whether the destination file path includes either or both of the following elements:

EXECUTION_ID

The ID that Amazon AppFlow assigns to the flow run.

SCHEMA_VERSION

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

• Source-to-destination field mappings

• Field data types

• Partition keys

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 hasPathPrefixHierarchy() method.

Returns:

Specifies whether the destination file path includes either or both of the following elements:

EXECUTION_ID

The ID that Amazon AppFlow assigns to the flow run.

SCHEMA_VERSION

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

• Source-to-destination field mappings

• Field data types

• Partition keys

hasPathPrefixHierarchy

public final boolean hasPathPrefixHierarchy()

For responses, this returns true if the service returned a value for the PathPrefixHierarchy 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.

pathPrefixHierarchyAsStrings

public final List<String> pathPrefixHierarchyAsStrings()

Specifies whether the destination file path includes either or both of the following elements:

EXECUTION_ID

The ID that Amazon AppFlow assigns to the flow run.

SCHEMA_VERSION

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

• Source-to-destination field mappings

• Field data types

• Partition keys

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 hasPathPrefixHierarchy() method.

Returns:

Specifies whether the destination file path includes either or both of the following elements:

EXECUTION_ID

The ID that Amazon AppFlow assigns to the flow run.

SCHEMA_VERSION

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

• Source-to-destination field mappings

• Field data types

• Partition keys

toBuilder

public PrefixConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PrefixConfig.Builder,PrefixConfig>

builder

public static PrefixConfig.Builder builder()

serializableBuilderClass

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