Class: AWSCDK::DataBrew::CfnDataset::ExcelOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_brew/cfn_dataset.rb

Overview

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(header_row: nil, sheet_indexes: nil, sheet_names: nil) ⇒ ExcelOptionsProperty

Returns a new instance of ExcelOptionsProperty.

Parameters:

  • header_row (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A variable that specifies whether the first row in the file is parsed as the header.

  • sheet_indexes (Array<Numeric>, AWSCDK::IResolvable, nil) (defaults to: nil) —

    One or more sheet numbers in the Excel file that will be included in the dataset.

  • sheet_names (Array<String>, nil) (defaults to: nil) —

    One or more named sheets in the Excel file that will be included in the dataset.



892
893
894
895
896
897
898
899
 
# File 'data_brew/cfn_dataset.rb', line 892

def initialize(header_row: nil, sheet_indexes: nil, sheet_names: nil)
  @header_row = header_row
  Jsii::Type.check_type(@header_row, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "headerRow") unless @header_row.nil?
  @sheet_indexes = sheet_indexes
  Jsii::Type.check_type(@sheet_indexes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siY29sbGVjdGlvbiI6eyJlbGVtZW50dHlwZSI6eyJwcmltaXRpdmUiOiJudW1iZXIifSwia2luZCI6ImFycmF5In19LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "sheetIndexes") unless @sheet_indexes.nil?
  @sheet_names = sheet_names
  Jsii::Type.check_type(@sheet_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "sheetNames") unless @sheet_names.nil?
end

Instance Attribute Details

#header_row ⇒ Boolean, ... (readonly)

A variable that specifies whether the first row in the file is parsed as the header.

If this value is false, column names are auto-generated.

Returns:

See Also:



907
908
909
 
# File 'data_brew/cfn_dataset.rb', line 907

def header_row
  @header_row
end

#sheet_indexes ⇒ Array<Numeric>, ... (readonly)

One or more sheet numbers in the Excel file that will be included in the dataset.

Returns:

See Also:



912
913
914
 
# File 'data_brew/cfn_dataset.rb', line 912

def sheet_indexes
  @sheet_indexes
end

#sheet_names ⇒ Array<String>? (readonly)

One or more named sheets in the Excel file that will be included in the dataset.

Returns:

  • (Array<String>, nil)

See Also:



917
918
919
 
# File 'data_brew/cfn_dataset.rb', line 917

def sheet_names
  @sheet_names
end

Class Method Details

.jsii_properties ⇒ Object 



919
920
921
922
923
924
925
 
# File 'data_brew/cfn_dataset.rb', line 919

def self.jsii_properties
  {
    :header_row => "headerRow",
    :sheet_indexes => "sheetIndexes",
    :sheet_names => "sheetNames",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



927
928
929
930
931
932
933
934
935
 
# File 'data_brew/cfn_dataset.rb', line 927

def to_jsii
  result = {}
  result.merge!({
    "headerRow" => @header_row,
    "sheetIndexes" => @sheet_indexes,
    "sheetNames" => @sheet_names,
  })
  result.compact
end