Class: Aws::FinSpaceData::Types::GetDataViewResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-finspacedata/types.rb

Overview

Response from retrieving a dataview, which includes details on the target database and table name

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#as_of_timestamp ⇒ Integer

Time range to use for the Dataview. 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:

  • (Integer) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#auto_update ⇒ Boolean

Flag to indicate Dataview should be updated automatically.

Returns:

  • (Boolean) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Integer

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:

  • (Integer) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#data_view_arn ⇒ String

The ARN identifier of the Dataview.

Returns:

  • (String) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#data_view_id ⇒ String

The unique identifier for the Dataview.

Returns:

  • (String) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_id ⇒ String

The unique identifier for the Dataset used in the Dataview.

Returns:

  • (String) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#destination_type_params ⇒ Types::DataViewDestinationTypeParams

Options that define the destination type for the Dataview.

Returns:



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#error_info ⇒ Types::DataViewErrorInfo

Information about an error that occurred for the Dataview.

Returns:



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Integer

The last time that a Dataview was modified. 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:

  • (Integer) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#partition_columns ⇒ Array<String>

Ordered set of column names used to partition data.

Returns:

  • (Array<String>) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#sort_columns ⇒ Array<String>

Columns to be used for sorting the data.

Returns:

  • (Array<String>) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a Dataview creation.

  • ‘RUNNING` – Dataview creation is running.

  • ‘STARTING` – Dataview creation is starting.

  • ‘FAILED` – Dataview creation has failed.

  • ‘CANCELLED` – Dataview creation has been cancelled.

  • ‘TIMEOUT` – Dataview creation has timed out.

  • ‘SUCCESS` – Dataview creation has succeeded.

  • ‘PENDING` – Dataview creation is pending.

  • ‘FAILED_CLEANUP_FAILED` – Dataview creation failed and resource cleanup failed.

Returns:

  • (String) 


1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-finspacedata/types.rb', line 1363

class GetDataViewResponse < Struct.new(
  :auto_update,
  :partition_columns,
  :dataset_id,
  :as_of_timestamp,
  :error_info,
  :last_modified_time,
  :create_time,
  :sort_columns,
  :data_view_id,
  :data_view_arn,
  :destination_type_params,
  :status)
  SENSITIVE = []
  include Aws::Structure
end