Class: Aws::Finspace::Types::GetKxDataviewResponse

Inherits:

Struct

Object
Struct
Aws::Finspace::Types::GetKxDataviewResponse

show all

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#active_versions ⇒ Array<Types::KxDataviewActiveVersion>
The current active changeset versions of the database on the given dataview.
#auto_update ⇒ Boolean
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested.
#availability_zone_id ⇒ String
The identifier of the availability zones.
#az_mode ⇒ String
The number of availability zones you want to assign per volume.
#changeset_id ⇒ String
A unique identifier of the changeset that you want to use to ingest data.
#created_timestamp ⇒ Time
The timestamp at which the dataview was created in FinSpace.
#database_name ⇒ String
The name of the database where you created the dataview.
#dataview_name ⇒ String
A unique identifier for the dataview.
#description ⇒ String
A description of the dataview.
#environment_id ⇒ String
A unique identifier for the kdb environment, from where you want to retrieve the dataview details.
#last_modified_timestamp ⇒ Time
The last time that the dataview was updated in FinSpace.
#read_write ⇒ Boolean
Returns True if the dataview is created as writeable and False otherwise.
#segment_configurations ⇒ Array<Types::KxDataviewSegmentConfiguration>
The configuration that contains the database path of the data that you want to place on each selected volume.
#status ⇒ String
The status of dataview creation.
#status_reason ⇒ String
The error message when a failed state occurs.

Instance Attribute Details

#active_versions ⇒ `Array<Types::KxDataviewActiveVersion>`

The current active changeset versions of the database on the given dataview.

Returns:

(Array<Types::KxDataviewActiveVersion>)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#auto_update ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#availability_zone_id ⇒ `String`

The identifier of the availability zones.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#az_mode ⇒ `String`

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)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#changeset_id ⇒ `String`

A unique identifier of the changeset that you want to use to ingest data.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#created_timestamp ⇒ `Time`

The timestamp at which the dataview 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)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#database_name ⇒ `String`

The name of the database where you created the dataview.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#dataview_name ⇒ `String`

A unique identifier for the dataview.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#description ⇒ `String`

A description of the dataview.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#environment_id ⇒ `String`

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#last_modified_timestamp ⇒ `Time`

The last time that the dataview 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)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#read_write ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#segment_configurations ⇒ `Array<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.

Returns:

(Array<Types::KxDataviewSegmentConfiguration>)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#status ⇒ `String`

The status of dataview creation.

CREATING – The dataview creation is in progress.
UPDATING – The dataview is in the process of being updated.
ACTIVE – The dataview is active.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

#status_reason ⇒ `String`

The error message when a failed state occurs.

Returns:

(String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2473

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

Class: Aws::Finspace::Types::GetKxDataviewResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#active_versions ⇒ Array<Types::KxDataviewActiveVersion>

#auto_update ⇒ Boolean

#availability_zone_id ⇒ String

#az_mode ⇒ String

#changeset_id ⇒ String

#created_timestamp ⇒ Time

#database_name ⇒ String

#dataview_name ⇒ String

#description ⇒ String

#environment_id ⇒ String

#last_modified_timestamp ⇒ Time

#read_write ⇒ Boolean

#segment_configurations ⇒ Array<Types::KxDataviewSegmentConfiguration>

#status ⇒ String

#status_reason ⇒ String

#active_versions ⇒ `Array<Types::KxDataviewActiveVersion>`

#auto_update ⇒ `Boolean`

#availability_zone_id ⇒ `String`

#az_mode ⇒ `String`

#changeset_id ⇒ `String`

#created_timestamp ⇒ `Time`

#database_name ⇒ `String`

#dataview_name ⇒ `String`

#description ⇒ `String`

#environment_id ⇒ `String`

#last_modified_timestamp ⇒ `Time`

#read_write ⇒ `Boolean`

#segment_configurations ⇒ `Array<Types::KxDataviewSegmentConfiguration>`

#status ⇒ `String`

#status_reason ⇒ `String`