Class: Aws::GlueDataBrew::Types::DatasetParameter
- Inherits:
-
Struct
- Object
- Struct
- Aws::GlueDataBrew::Types::DatasetParameter
- Defined in:
- gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb
Overview
When making an API call, you may pass DatasetParameter data as a hash:
{
name: "PathParameterName", # required
type: "Datetime", # required, accepts Datetime, Number, String
datetime_options: {
format: "DatetimeFormat", # required
timezone_offset: "TimezoneOffset",
locale_code: "LocaleCode",
},
create_column: false,
filter: {
expression: "Expression", # required
values_map: { # required
"ValueReference" => "ConditionValue",
},
},
}
Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#create_column ⇒ Boolean
Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
-
#datetime_options ⇒ Types::DatetimeOptions
Additional parameter options such as a format and a timezone.
-
#filter ⇒ Types::FilterExpression
The optional filter expression structure to apply additional matching criteria to the parameter.
-
#name ⇒ String
The name of the parameter that is used in the dataset's Amazon S3 path.
-
#type ⇒ String
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
Instance Attribute Details
#create_column ⇒ Boolean
Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 1455 class DatasetParameter < Struct.new( :name, :type, :datetime_options, :create_column, :filter) SENSITIVE = [] include Aws::Structure end |
#datetime_options ⇒ Types::DatetimeOptions
Additional parameter options such as a format and a timezone. Required for datetime parameters.
1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 1455 class DatasetParameter < Struct.new( :name, :type, :datetime_options, :create_column, :filter) SENSITIVE = [] include Aws::Structure end |
#filter ⇒ Types::FilterExpression
The optional filter expression structure to apply additional matching criteria to the parameter.
1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 1455 class DatasetParameter < Struct.new( :name, :type, :datetime_options, :create_column, :filter) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the parameter that is used in the dataset's Amazon S3 path.
1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 1455 class DatasetParameter < Struct.new( :name, :type, :datetime_options, :create_column, :filter) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 1455 class DatasetParameter < Struct.new( :name, :type, :datetime_options, :create_column, :filter) SENSITIVE = [] include Aws::Structure end |