software.amazon.awssdk.services.glue.model

Class Spigot

java.lang.Object

software.amazon.awssdk.services.glue.model.Spigot

All Implemented Interfaces:

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

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

Specifies a transform that writes samples of the data to an Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Spigot.Builder

Method Summary

Modifier and Type	Method and Description
static Spigot.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputs() For responses, this returns true if the service returned a value for the Inputs property.
List<String>	inputs() The data inputs identified by their node names.
String	name() The name of the transform node.
String	path() A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Double	prob() The probability (a decimal value with a maximum value of 1) of picking any given record.
List<SdkField<?>>	sdkFields()
static Class<? extends Spigot.Builder>	serializableBuilderClass()
Spigot.Builder	toBuilder()
Integer	topk() Specifies a number of records to write starting from the beginning of the dataset.
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

name

public final String name()

The name of the transform node.

Returns:

The name of the transform node.

hasInputs

public final boolean hasInputs()

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

inputs

public final List<String> inputs()

The data inputs identified by their node names.

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

Returns:

The data inputs identified by their node names.

path

public final String path()

A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.

Returns:

A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.

topk

public final Integer topk()

Specifies a number of records to write starting from the beginning of the dataset.

Returns:

Specifies a number of records to write starting from the beginning of the dataset.

prob

public final Double prob()

The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

Returns:

The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.

toBuilder

public Spigot.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Spigot.Builder,Spigot>

builder

public static Spigot.Builder builder()

serializableBuilderClass

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