Class: Aws::GlueDataBrew::Types::Output

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb

Overview

Note:

When making an API call, you may pass Output data as a hash:

{
  compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
  format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML, TABLEAUHYPER
  partition_columns: ["ColumnName"],
  location: { # required
    bucket: "Bucket", # required
    key: "Key",
    bucket_owner: "BucketOwner",
  },
  overwrite: false,
  format_options: {
    csv: {
      delimiter: "Delimiter",
    },
  },
  max_output_files: 1,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compression_formatString

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

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end

#formatString

The data format of the output of the job.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end

#format_optionsTypes::OutputFormatOptions

Represents options that define how DataBrew formats job output files.



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end

#locationTypes::S3Location

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

Returns:



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end

#max_output_filesInteger

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:

  • (Integer)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end

#overwriteBoolean

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

Returns:

  • (Boolean)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end

#partition_columnsArray<String>

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

Returns:

  • (Array<String>)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 3636

class Output < Struct.new(
  :compression_format,
  :format,
  :partition_columns,
  :location,
  :overwrite,
  :format_options,
  :max_output_files)
  SENSITIVE = []
  include Aws::Structure
end