Spigot (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glue.model.Spigot

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Spigot
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a transform that writes samples of the data to an Amazon S3 bucket.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Spigot()

Constructors
Constructor and Description
`Spigot()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Spigot`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getInputs()` The data inputs identified by their node names.
`String`	`getName()` The name of the transform node.
`String`	`getPath()` 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`	`getProb()` The probability (a decimal value with a maximum value of 1) of picking any given record.
`Integer`	`getTopk()` Specifies a number of records to write starting from the beginning of the dataset.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInputs(Collection<String> inputs)` The data inputs identified by their node names.
`void`	`setName(String name)` The name of the transform node.
`void`	`setPath(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.
`void`	`setProb(Double prob)` The probability (a decimal value with a maximum value of 1) of picking any given record.
`void`	`setTopk(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.
`Spigot`	`withInputs(Collection<String> inputs)` The data inputs identified by their node names.
`Spigot`	`withInputs(String... inputs)` The data inputs identified by their node names.
`Spigot`	`withName(String name)` The name of the transform node.
`Spigot`	`withPath(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.
`Spigot`	`withProb(Double prob)` The probability (a decimal value with a maximum value of 1) of picking any given record.
`Spigot`	`withTopk(Integer topk)` Specifies a number of records to write starting from the beginning of the dataset.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Spigot
```
public Spigot()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the transform node.
    
    Parameters:
    
    name - The name of the transform node.
  - getName
```
public String getName()
```
    The name of the transform node.
    
    Returns:
    
    The name of the transform node.
  - withName
```
public Spigot withName(String name)
```
    The name of the transform node.
    
    Parameters:
    
    name - The name of the transform node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputs
```
public List<String> getInputs()
```
    The data inputs identified by their node names.
    
    Returns:
    
    The data inputs identified by their node names.
  - setInputs
```
public void setInputs(Collection<String> inputs)
```
    The data inputs identified by their node names.
    
    Parameters:
    
    inputs - The data inputs identified by their node names.
  - withInputs
```
public Spigot withInputs(String... inputs)
```
    The data inputs identified by their node names.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputs(java.util.Collection) or withInputs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inputs - The data inputs identified by their node names.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputs
```
public Spigot withInputs(Collection<String> inputs)
```
    The data inputs identified by their node names.
    
    Parameters:
    
    inputs - The data inputs identified by their node names.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(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.
    
    Parameters:
    
    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.
  - getPath
```
public String getPath()
```
    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.
  - withPath
```
public Spigot withPath(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTopk
```
public void setTopk(Integer topk)
```
    Specifies a number of records to write starting from the beginning of the dataset.
    
    Parameters:
    
    topk - Specifies a number of records to write starting from the beginning of the dataset.
  - getTopk
```
public Integer getTopk()
```
    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.
  - withTopk
```
public Spigot withTopk(Integer topk)
```
    Specifies a number of records to write starting from the beginning of the dataset.
    
    Parameters:
    
    topk - Specifies a number of records to write starting from the beginning of the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProb
```
public void setProb(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.
    
    Parameters:
    
    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.
  - getProb
```
public Double getProb()
```
    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.
  - withProb
```
public Spigot withProb(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Spigot clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Spigot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Spigot

Method Detail

setName

getName

withName

getInputs

setInputs

withInputs

withInputs

setPath

getPath

withPath

setTopk

getTopk

withTopk

setProb

getProb

withProb

toString

equals

hashCode

clone

marshall