Interface Output.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Output.Builder,Output>,SdkBuilder<Output.Builder,Output>,SdkPojo
- Enclosing class:
- Output
public static interface Output.Builder extends SdkPojo, CopyableBuilder<Output.Builder,Output>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Output.BuildercompressionFormat(String compressionFormat)The compression algorithm used to compress the output text of the job.Output.BuildercompressionFormat(CompressionFormat compressionFormat)The compression algorithm used to compress the output text of the job.Output.Builderformat(String format)The data format of the output of the job.Output.Builderformat(OutputFormat format)The data format of the output of the job.default Output.BuilderformatOptions(Consumer<OutputFormatOptions.Builder> formatOptions)Represents options that define how DataBrew formats job output files.Output.BuilderformatOptions(OutputFormatOptions formatOptions)Represents options that define how DataBrew formats job output files.default Output.Builderlocation(Consumer<S3Location.Builder> location)The location in Amazon S3 where the job writes its output.Output.Builderlocation(S3Location location)The location in Amazon S3 where the job writes its output.Output.BuildermaxOutputFiles(Integer maxOutputFiles)Maximum number of files to be generated by the job and written to the output folder.Output.Builderoverwrite(Boolean overwrite)A value that, if true, means that any data in the location specified for output is overwritten with new output.Output.BuilderpartitionColumns(String... partitionColumns)The names of one or more partition columns for the output of the job.Output.BuilderpartitionColumns(Collection<String> partitionColumns)The names of one or more partition columns for the output of the job.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
compressionFormat
Output.Builder compressionFormat(String compressionFormat)
The compression algorithm used to compress the output text of the job.
- Parameters:
compressionFormat- The compression algorithm used to compress the output text of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompressionFormat,CompressionFormat
-
compressionFormat
Output.Builder compressionFormat(CompressionFormat compressionFormat)
The compression algorithm used to compress the output text of the job.
- Parameters:
compressionFormat- The compression algorithm used to compress the output text of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompressionFormat,CompressionFormat
-
format
Output.Builder format(String format)
The data format of the output of the job.
- Parameters:
format- The data format of the output of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
OutputFormat,OutputFormat
-
format
Output.Builder format(OutputFormat format)
The data format of the output of the job.
- Parameters:
format- The data format of the output of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
OutputFormat,OutputFormat
-
partitionColumns
Output.Builder partitionColumns(Collection<String> partitionColumns)
The names of one or more partition columns for the output of the job.
- Parameters:
partitionColumns- The names of one or more partition columns for the output of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
partitionColumns
Output.Builder partitionColumns(String... partitionColumns)
The names of one or more partition columns for the output of the job.
- Parameters:
partitionColumns- The names of one or more partition columns for the output of the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
location
Output.Builder location(S3Location location)
The location in Amazon S3 where the job writes its output.
- Parameters:
location- The location in Amazon S3 where the job writes its output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
location
default Output.Builder location(Consumer<S3Location.Builder> location)
The location in Amazon S3 where the job writes its output.
This is a convenience method that creates an instance of theS3Location.Builderavoiding the need to create one manually viaS3Location.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolocation(S3Location).- Parameters:
location- a consumer that will call methods onS3Location.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
location(S3Location)
-
overwrite
Output.Builder overwrite(Boolean overwrite)
A value that, if true, means that any data in the location specified for output is overwritten with new output.
- Parameters:
overwrite- A value that, if true, means that any data in the location specified for output is overwritten with new output.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
formatOptions
Output.Builder formatOptions(OutputFormatOptions formatOptions)
Represents options that define how DataBrew formats job output files.
- Parameters:
formatOptions- Represents options that define how DataBrew formats job output files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
formatOptions
default Output.Builder formatOptions(Consumer<OutputFormatOptions.Builder> formatOptions)
Represents options that define how DataBrew formats job output files.
This is a convenience method that creates an instance of theOutputFormatOptions.Builderavoiding the need to create one manually viaOutputFormatOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toformatOptions(OutputFormatOptions).- Parameters:
formatOptions- a consumer that will call methods onOutputFormatOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
formatOptions(OutputFormatOptions)
-
maxOutputFiles
Output.Builder maxOutputFiles(Integer maxOutputFiles)
Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.
- Parameters:
maxOutputFiles- Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-