software.amazon.awssdk.services.lexmodelsv2.model

Class PathFormat

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.PathFormat

All Implemented Interfaces:

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

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

The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PathFormat.Builder

Method Summary

Modifier and Type	Method and Description
static PathFormat.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasObjectPrefixes() For responses, this returns true if the service returned a value for the ObjectPrefixes property.
List<String>	objectPrefixes() A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends PathFormat.Builder>	serializableBuilderClass()
PathFormat.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

hasObjectPrefixes

public final boolean hasObjectPrefixes()

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

objectPrefixes

public final List<String> objectPrefixes()

A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.

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

Returns:

A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.

toBuilder

public PathFormat.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PathFormat.Builder,PathFormat>

builder

public static PathFormat.Builder builder()

serializableBuilderClass

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