Package software.amazon.awscdk.services.databrew

Interface CfnJob.OutputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJob.OutputProperty.Jsii$Proxy

Enclosing class:

CfnJob

@Stability(Stable)
public static interface CfnJob.OutputProperty
extends software.amazon.jsii.JsiiSerializable

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.databrew.*;
 OutputProperty outputProperty = OutputProperty.builder()
         .location(S3LocationProperty.builder()
                 .bucket("bucket")
                 // the properties below are optional
                 .bucketOwner("bucketOwner")
                 .key("key")
                 .build())
         // the properties below are optional
         .compressionFormat("compressionFormat")
         .format("format")
         .formatOptions(OutputFormatOptionsProperty.builder()
                 .csv(CsvOutputOptionsProperty.builder()
                         .delimiter("delimiter")
                         .build())
                 .build())
         .maxOutputFiles(123)
         .overwrite(false)
         .partitionColumns(List.of("partitionColumns"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJob.OutputProperty.Builder	A builder for CfnJob.OutputProperty
static final class	CfnJob.OutputProperty.Jsii$Proxy	An implementation for CfnJob.OutputProperty

Method Summary

Modifier and Type	Method	Description
static CfnJob.OutputProperty.Builder	builder()
default String	getCompressionFormat()	The compression algorithm used to compress the output text of the job.
default String	getFormat()	The data format of the output of the job.
default Object	getFormatOptions()	Represents options that define how DataBrew formats job output files.
Object	getLocation()	The location in Amazon S3 where the job writes its output.
default Number	getMaxOutputFiles()	The maximum number of files to be generated by the job and written to the output folder.
default Object	getOverwrite()	A value that, if true, means that any data in the location specified for output is overwritten with new output.
default List<String>	getPartitionColumns()	The names of one or more partition columns for the output of the job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLocation

@Stability(Stable)
@NotNull
Object getLocation()

The location in Amazon S3 where the job writes its output.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-location

getCompressionFormat

@Stability(Stable)
@Nullable
default String getCompressionFormat()

The compression algorithm used to compress the output text of the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-compressionformat

getFormat

@Stability(Stable)
@Nullable
default String getFormat()

The data format of the output of the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-format

getFormatOptions

@Stability(Stable)
@Nullable
default Object getFormatOptions()

Represents options that define how DataBrew formats job output files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-formatoptions

getMaxOutputFiles

@Stability(Stable)
@Nullable
default Number getMaxOutputFiles()

The maximum number of files to be generated by the job and written to the output folder.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-maxoutputfiles

getOverwrite

@Stability(Stable)
@Nullable
default Object getOverwrite()

A value that, if true, means that any data in the location specified for output is overwritten with new output.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-overwrite

getPartitionColumns

@Stability(Stable)
@Nullable
default List<String> getPartitionColumns()

The names of one or more partition columns for the output of the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-partitioncolumns

builder

@Stability(Stable)
static CfnJob.OutputProperty.Builder builder()

Returns:

a CfnJob.OutputProperty.Builder of CfnJob.OutputProperty