Class: Aws::Finspace::Types::KxDataviewListEntry

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

Overview

A collection of kdb dataview entries.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_versionsArray<Types::KxDataviewActiveVersion>

The active changeset versions for the given dataview entry.

Returns:



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#auto_updateBoolean

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.

Returns:

  • (Boolean)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_idString

The identifier of the availability zones.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#az_modeString

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#changeset_idString

A unique identifier for the changeset.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#created_timestampTime

The timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

  • (Time)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

A unique identifier of the database.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#dataview_nameString

A unique identifier of the dataview.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the dataview list entry.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#environment_idString

A unique identifier for the kdb environment.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timestampTime

The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

  • (Time)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#read_writeBoolean

Returns True if the dataview is created as writeable and False otherwise.

Returns:

  • (Boolean)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#segment_configurationsArray<Types::KxDataviewSegmentConfiguration>

The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of a given dataview entry.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

The error message when a failed state occurs.

Returns:

  • (String)


3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 3513

class KxDataviewListEntry < Struct.new(
  :environment_id,
  :database_name,
  :dataview_name,
  :az_mode,
  :availability_zone_id,
  :changeset_id,
  :segment_configurations,
  :active_versions,
  :status,
  :description,
  :auto_update,
  :read_write,
  :created_timestamp,
  :last_modified_timestamp,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end