Class: AWSCDK::DataBrew::CfnJob::JobSampleProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::DataBrew::CfnJob::JobSampleProperty

Defined in:

data_brew/cfn_job.rb

Overview

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

See Also:

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

Instance Attribute Summary

• #mode ⇒ String^? readonly

  A value that determines whether the profile job is run on the entire dataset or a specified number of rows.

• #size ⇒ Numeric^? readonly

  The Size parameter is only required when the mode is CUSTOM_ROWS.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(mode: nil, size: nil) ⇒ JobSampleProperty constructor

  A new instance of JobSampleProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(mode: nil, size: nil) ⇒ JobSampleProperty

Returns a new instance of JobSampleProperty.

Parameters:

• mode (String, nil) (defaults to: nil) —

  A value that determines whether the profile job is run on the entire dataset or a specified number of rows.

• size (Numeric, nil) (defaults to: nil) —

  The Size parameter is only required when the mode is CUSTOM_ROWS.

# File 'data_brew/cfn_job.rb', line 1170

def initialize(mode: nil, size: nil)
  @mode = mode
  Jsii::Type.check_type(@mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode") unless @mode.nil?
  @size = size
  Jsii::Type.check_type(@size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "size") unless @size.nil?
end

Instance Attribute Details

#mode ⇒ String^? (readonly)

A value that determines whether the profile job is run on the entire dataset or a specified number of rows.

This value must be one of the following:

• FULL_DATASET - The profile job is run on the entire dataset.
• CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

Returns:

• (String, nil)

See Also:

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

# File 'data_brew/cfn_job.rb', line 1186

def mode
  @mode
end

#size ⇒ Numeric^? (readonly)

The Size parameter is only required when the mode is CUSTOM_ROWS.

The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

Returns:

• (Numeric, nil)

See Also:

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

# File 'data_brew/cfn_job.rb', line 1195

def size
  @size
end

Class Method Details

.jsii_properties ⇒ Object

# File 'data_brew/cfn_job.rb', line 1197

def self.jsii_properties
  {
    :mode => "mode",
    :size => "size",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'data_brew/cfn_job.rb', line 1204

def to_jsii
  result = {}
  result.merge!({
    "mode" => @mode,
    "size" => @size,
  })
  result.compact
end