Package software.amazon.awssdk.services.databrew.model

Class PathOptions

java.lang.Object

software.amazon.awssdk.services.databrew.model.PathOptions

All Implemented Interfaces:

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

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

Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PathOptions.Builder

Method Summary

Modifier and Type	Method	Description
static PathOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilesLimit	filesLimit()	If provided, this structure imposes a limit on a number of files that should be selected.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
FilterExpression	lastModifiedDateCondition()	If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.
Map<String,DatasetParameter>	parameters()	A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PathOptions.Builder>	serializableBuilderClass()
PathOptions.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

lastModifiedDateCondition

public final FilterExpression lastModifiedDateCondition()

If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.

Returns:

If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.

filesLimit

public final FilesLimit filesLimit()

If provided, this structure imposes a limit on a number of files that should be selected.

Returns:

If provided, this structure imposes a limit on a number of files that should be selected.

hasParameters

public final boolean hasParameters()

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

parameters

public final Map<String,DatasetParameter> parameters()

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

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

Returns:

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

toBuilder

public PathOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PathOptions.Builder,PathOptions>

builder

public static PathOptions.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo