DatasetParameter (AWS Java SDK for AWS Glue DataBrew 1.12.1 API)

java.lang.Object
- com.amazonaws.services.gluedatabrew.model.DatasetParameter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DatasetParameter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a dataset paramater that defines type and conditions for a parameter in the S3 path of the dataset.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DatasetParameter()

Constructors
Constructor and Description
`DatasetParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DatasetParameter`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCreateColumn()` Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
`DatetimeOptions`	`getDatetimeOptions()` Additional parameter options such as a format and a timezone.
`FilterExpression`	`getFilter()` The optional filter expression structure to apply additional matching criteria to the parameter.
`String`	`getName()` The name of the parameter that is used in the dataset's S3 path.
`String`	`getType()` The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
`int`	`hashCode()`
`Boolean`	`isCreateColumn()` Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCreateColumn(Boolean createColumn)` Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
`void`	`setDatetimeOptions(DatetimeOptions datetimeOptions)` Additional parameter options such as a format and a timezone.
`void`	`setFilter(FilterExpression filter)` The optional filter expression structure to apply additional matching criteria to the parameter.
`void`	`setName(String name)` The name of the parameter that is used in the dataset's S3 path.
`void`	`setType(String type)` The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
`String`	`toString()` Returns a string representation of this object.
`DatasetParameter`	`withCreateColumn(Boolean createColumn)` Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
`DatasetParameter`	`withDatetimeOptions(DatetimeOptions datetimeOptions)` Additional parameter options such as a format and a timezone.
`DatasetParameter`	`withFilter(FilterExpression filter)` The optional filter expression structure to apply additional matching criteria to the parameter.
`DatasetParameter`	`withName(String name)` The name of the parameter that is used in the dataset's S3 path.
`DatasetParameter`	`withType(ParameterType type)` The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
`DatasetParameter`	`withType(String type)` The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

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

- Constructor Detail
  - DatasetParameter
```
public DatasetParameter()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the parameter that is used in the dataset's S3 path.
    
    Parameters:
    
    name - The name of the parameter that is used in the dataset's S3 path.
  - getName
```
public String getName()
```
    The name of the parameter that is used in the dataset's S3 path.
    
    Returns:
    
    The name of the parameter that is used in the dataset's S3 path.
  - withName
```
public DatasetParameter withName(String name)
```
    The name of the parameter that is used in the dataset's S3 path.
    
    Parameters:
    
    name - The name of the parameter that is used in the dataset's S3 path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    Parameters:
    
    type - The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    See Also:
    
    ParameterType
  - getType
```
public String getType()
```
    The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    Returns:
    
    The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    See Also:
    
    ParameterType
  - withType
```
public DatasetParameter withType(String type)
```
    The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    Parameters:
    
    type - The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - withType
```
public DatasetParameter withType(ParameterType type)
```
    The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    Parameters:
    
    type - The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - setDatetimeOptions
```
public void setDatetimeOptions(DatetimeOptions datetimeOptions)
```
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    
    Parameters:
    
    datetimeOptions - Additional parameter options such as a format and a timezone. Required for datetime parameters.
  - getDatetimeOptions
```
public DatetimeOptions getDatetimeOptions()
```
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    
    Returns:
    
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
  - withDatetimeOptions
```
public DatasetParameter withDatetimeOptions(DatetimeOptions datetimeOptions)
```
    Additional parameter options such as a format and a timezone. Required for datetime parameters.
    
    Parameters:
    
    datetimeOptions - Additional parameter options such as a format and a timezone. Required for datetime parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateColumn
```
public void setCreateColumn(Boolean createColumn)
```
    Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
    
    Parameters:
    
    createColumn - Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
  - getCreateColumn
```
public Boolean getCreateColumn()
```
    Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
    
    Returns:
    
    Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
  - withCreateColumn
```
public DatasetParameter withCreateColumn(Boolean createColumn)
```
    Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
    
    Parameters:
    
    createColumn - Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCreateColumn
```
public Boolean isCreateColumn()
```
    Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
    
    Returns:
    
    Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
  - setFilter
```
public void setFilter(FilterExpression filter)
```
    The optional filter expression structure to apply additional matching criteria to the parameter.
    
    Parameters:
    
    filter - The optional filter expression structure to apply additional matching criteria to the parameter.
  - getFilter
```
public FilterExpression getFilter()
```
    The optional filter expression structure to apply additional matching criteria to the parameter.
    
    Returns:
    
    The optional filter expression structure to apply additional matching criteria to the parameter.
  - withFilter
```
public DatasetParameter withFilter(FilterExpression filter)
```
    The optional filter expression structure to apply additional matching criteria to the parameter.
    
    Parameters:
    
    filter - The optional filter expression structure to apply additional matching criteria to the parameter.
    
    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 DatasetParameter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class DatasetParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatasetParameter

Method Detail

setName

getName

withName

setType

getType

withType

withType

setDatetimeOptions

getDatetimeOptions

withDatetimeOptions

setCreateColumn

getCreateColumn

withCreateColumn

isCreateColumn

setFilter

getFilter

withFilter

toString

equals

hashCode

clone

marshall