Class: Aws::QuickSight::Types::DataSet

Inherits:

Struct

Object
Struct
Aws::QuickSight::Types::DataSet

show all

Defined in:: gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Dataset.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String
The Amazon Resource Name (ARN) of the resource.
#column_groups ⇒ Array<Types::ColumnGroup>
Groupings of columns that work together in certain Amazon QuickSight features.
#column_level_permission_rules ⇒ Array<Types::ColumnLevelPermissionRule>
A set of one or more definitions of a ColumnLevelPermissionRule.
#consumed_spice_capacity_in_bytes ⇒ Integer
The amount of SPICE capacity used by this dataset.
#created_time ⇒ Time
The time that this dataset was created.
#data_set_id ⇒ String
The ID of the dataset.
#data_set_usage_configuration ⇒ Types::DataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
#dataset_parameters ⇒ Array<Types::DatasetParameter>
The parameters that are declared in a dataset.
#field_folders ⇒ Hash<String,Types::FieldFolder>
The folder that contains fields and nested subfolders for your dataset.
#import_mode ⇒ String
A value that indicates whether you want to import the data into SPICE.
#last_updated_time ⇒ Time
The last time that this dataset was updated.
#logical_table_map ⇒ Hash<String,Types::LogicalTable>
Configures the combination and transformation of the data from the physical tables.
#name ⇒ String
A display name for the dataset.
#output_columns ⇒ Array<Types::OutputColumn>
The list of columns after all transforms.
#performance_configuration ⇒ Types::PerformanceConfiguration
The performance optimization configuration of a dataset.
#physical_table_map ⇒ Hash<String,Types::PhysicalTable>
Declares the physical tables that are available in the underlying data sources.
#row_level_permission_data_set ⇒ Types::RowLevelPermissionDataSet
The row-level security configuration for the dataset.
#row_level_permission_tag_configuration ⇒ Types::RowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.

Instance Attribute Details

#arn ⇒ `String`

The Amazon Resource Name (ARN) of the resource.

Returns:

(String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#column_groups ⇒ `Array<Types::ColumnGroup>`

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Returns:

(Array<Types::ColumnGroup>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#column_level_permission_rules ⇒ `Array<Types::ColumnLevelPermissionRule>`

A set of one or more definitions of a ColumnLevelPermissionRule.

Returns:

(Array<Types::ColumnLevelPermissionRule>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_spice_capacity_in_bytes ⇒ `Integer`

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

Returns:

(Integer)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ `Time`

The time that this dataset was created.

Returns:

(Time)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_set_id ⇒ `String`

The ID of the dataset.

Returns:

(String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_set_usage_configuration ⇒ `Types::DataSetUsageConfiguration`

The usage configuration to apply to child datasets that reference this dataset as a source.

Returns:

(Types::DataSetUsageConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_parameters ⇒ `Array<Types::DatasetParameter>`

The parameters that are declared in a dataset.

Returns:

(Array<Types::DatasetParameter>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#field_folders ⇒ `Hash<String,Types::FieldFolder>`

The folder that contains fields and nested subfolders for your dataset.

Returns:

(Hash<String,Types::FieldFolder>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#import_mode ⇒ `String`

A value that indicates whether you want to import the data into SPICE.

Returns:

(String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ `Time`

The last time that this dataset was updated.

Returns:

(Time)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#logical_table_map ⇒ `Hash<String,Types::LogicalTable>`

Configures the combination and transformation of the data from the physical tables.

Returns:

(Hash<String,Types::LogicalTable>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

A display name for the dataset.

Returns:

(String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#output_columns ⇒ `Array<Types::OutputColumn>`

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Returns:

(Array<Types::OutputColumn>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#performance_configuration ⇒ `Types::PerformanceConfiguration`

The performance optimization configuration of a dataset.

Returns:

(Types::PerformanceConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#physical_table_map ⇒ `Hash<String,Types::PhysicalTable>`

Declares the physical tables that are available in the underlying data sources.

Returns:

(Hash<String,Types::PhysicalTable>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#row_level_permission_data_set ⇒ `Types::RowLevelPermissionDataSet`

The row-level security configuration for the dataset.

Returns:

(Types::RowLevelPermissionDataSet)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#row_level_permission_tag_configuration ⇒ `Types::RowLevelPermissionTagConfiguration`

The element you can use to define tags for row-level security.

Returns:

(Types::RowLevelPermissionTagConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8968

class DataSet < Struct.new(
  :arn,
  :data_set_id,
  :name,
  :created_time,
  :last_updated_time,
  :physical_table_map,
  :logical_table_map,
  :output_columns,
  :import_mode,
  :consumed_spice_capacity_in_bytes,
  :column_groups,
  :field_folders,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :data_set_usage_configuration,
  :dataset_parameters,
  :performance_configuration)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::QuickSight::Types::DataSet

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#column_groups ⇒ Array<Types::ColumnGroup>

#column_level_permission_rules ⇒ Array<Types::ColumnLevelPermissionRule>

#consumed_spice_capacity_in_bytes ⇒ Integer

#created_time ⇒ Time

#data_set_id ⇒ String

#data_set_usage_configuration ⇒ Types::DataSetUsageConfiguration

#dataset_parameters ⇒ Array<Types::DatasetParameter>

#field_folders ⇒ Hash<String,Types::FieldFolder>

#import_mode ⇒ String

#last_updated_time ⇒ Time

#logical_table_map ⇒ Hash<String,Types::LogicalTable>

#name ⇒ String

#output_columns ⇒ Array<Types::OutputColumn>

#performance_configuration ⇒ Types::PerformanceConfiguration

#physical_table_map ⇒ Hash<String,Types::PhysicalTable>

#row_level_permission_data_set ⇒ Types::RowLevelPermissionDataSet

#row_level_permission_tag_configuration ⇒ Types::RowLevelPermissionTagConfiguration

#arn ⇒ `String`

#column_groups ⇒ `Array<Types::ColumnGroup>`

#column_level_permission_rules ⇒ `Array<Types::ColumnLevelPermissionRule>`

#consumed_spice_capacity_in_bytes ⇒ `Integer`

#created_time ⇒ `Time`

#data_set_id ⇒ `String`

#data_set_usage_configuration ⇒ `Types::DataSetUsageConfiguration`

#dataset_parameters ⇒ `Array<Types::DatasetParameter>`

#field_folders ⇒ `Hash<String,Types::FieldFolder>`

#import_mode ⇒ `String`

#last_updated_time ⇒ `Time`

#logical_table_map ⇒ `Hash<String,Types::LogicalTable>`

#name ⇒ `String`

#output_columns ⇒ `Array<Types::OutputColumn>`

#performance_configuration ⇒ `Types::PerformanceConfiguration`

#physical_table_map ⇒ `Hash<String,Types::PhysicalTable>`

#row_level_permission_data_set ⇒ `Types::RowLevelPermissionDataSet`

#row_level_permission_tag_configuration ⇒ `Types::RowLevelPermissionTagConfiguration`