Class: Aws::CleanRooms::Types::AnalysisRuleAggregation

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

Overview

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregate_columns ⇒ Array<Types::AggregateColumn>

The columns that query runners are allowed to use in aggregation queries.

Returns:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_join_operators ⇒ Array<String>

Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.

Returns:

  • (Array<String>) 


193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end

#dimension_columns ⇒ Array<String>

The columns that query runners are allowed to select, group by, or filter by.

Returns:

  • (Array<String>) 


193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end

#join_columns ⇒ Array<String>

Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

Returns:

  • (Array<String>) 


193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end

#join_required ⇒ String

Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

Returns:

  • (String) 


193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end

#output_constraints ⇒ Array<Types::AggregationConstraint>

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

Returns:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end

#scalar_functions ⇒ Array<String>

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

Returns:

  • (Array<String>) 


193
194
195
196
197
198
199
200
201
202
203
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 193

class AnalysisRuleAggregation < Struct.new(
  :aggregate_columns,
  :join_columns,
  :join_required,
  :allowed_join_operators,
  :dimension_columns,
  :scalar_functions,
  :output_constraints)
  SENSITIVE = []
  include Aws::Structure
end