software.amazon.awscdk.services.quicksight

Interface CfnDataSet.PhysicalTableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.PhysicalTableProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(value=Stable)
public static interface CfnDataSet.PhysicalTableProperty
extends software.amazon.jsii.JsiiSerializable

A view of a data source that contains information about the shape of the data in the underlying source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 PhysicalTableProperty physicalTableProperty = PhysicalTableProperty.builder()
         .customSql(CustomSqlProperty.builder()
                 .columns(List.of(InputColumnProperty.builder()
                         .name("name")
                         .type("type")
                         .build()))
                 .dataSourceArn("dataSourceArn")
                 .name("name")
                 .sqlQuery("sqlQuery")
                 .build())
         .relationalTable(RelationalTableProperty.builder()
                 .dataSourceArn("dataSourceArn")
                 .inputColumns(List.of(InputColumnProperty.builder()
                         .name("name")
                         .type("type")
                         .build()))
                 .name("name")
                 // the properties below are optional
                 .catalog("catalog")
                 .schema("schema")
                 .build())
         .s3Source(S3SourceProperty.builder()
                 .dataSourceArn("dataSourceArn")
                 .inputColumns(List.of(InputColumnProperty.builder()
                         .name("name")
                         .type("type")
                         .build()))
                 // the properties below are optional
                 .uploadSettings(UploadSettingsProperty.builder()
                         .containsHeader(false)
                         .delimiter("delimiter")
                         .format("format")
                         .startFromRow(123)
                         .textQualifier("textQualifier")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSet.PhysicalTableProperty.Builder A builder for CfnDataSet.PhysicalTableProperty
static class	CfnDataSet.PhysicalTableProperty.Jsii$Proxy An implementation for CfnDataSet.PhysicalTableProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSet.PhysicalTableProperty.Builder	builder()
default Object	getCustomSql() A physical table type built from the results of the custom SQL query.
default Object	getRelationalTable() A physical table type for relational data sources.
default Object	getS3Source() A physical table type for as S3 data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCustomSql

@Stability(value=Stable)
 @Nullable
default Object getCustomSql()

A physical table type built from the results of the custom SQL query.

getRelationalTable

@Stability(value=Stable)
 @Nullable
default Object getRelationalTable()

A physical table type for relational data sources.

getS3Source

@Stability(value=Stable)
 @Nullable
default Object getS3Source()

A physical table type for as S3 data source.

builder

@Stability(value=Stable)
static CfnDataSet.PhysicalTableProperty.Builder builder()

Returns:

a CfnDataSet.PhysicalTableProperty.Builder of CfnDataSet.PhysicalTableProperty