software.amazon.awscdk.services.redshift.alpha.TableProps Maven / Gradle / Ivy
Show all versions of redshift-alpha Show documentation
package software.amazon.awscdk.services.redshift.alpha;
/**
* (experimental) Properties for configuring a Redshift table.
*
* Example:
*
*
* Table.Builder.create(this, "Table")
* .tableColumns(List.of(Column.builder().name("col1").dataType("varchar(4)").distKey(true).build(), Column.builder().name("col2").dataType("float").build()))
* .cluster(cluster)
* .databaseName("databaseName")
* .distStyle(TableDistStyle.KEY)
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-19T18:12:10.185Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.redshift.alpha.$Module.class, fqn = "@aws-cdk/aws-redshift-alpha.TableProps")
@software.amazon.jsii.Jsii.Proxy(TableProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface TableProps extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.redshift.alpha.DatabaseOptions {
/**
* (experimental) The columns of the table.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.util.List getTableColumns();
/**
* (experimental) The distribution style of the table.
*
* Default: TableDistStyle.AUTO
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.redshift.alpha.TableDistStyle getDistStyle() {
return null;
}
/**
* (experimental) The policy to apply when this resource is removed from the application.
*
* Default: cdk.RemovalPolicy.Retain
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.RemovalPolicy getRemovalPolicy() {
return null;
}
/**
* (experimental) The sort style of the table.
*
* Default: TableSortStyle.AUTO if no sort key is specified, TableSortStyle.COMPOUND if a sort key is specified
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.redshift.alpha.TableSortStyle getSortStyle() {
return null;
}
/**
* (experimental) A comment to attach to the table.
*
* Default: - no comment
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getTableComment() {
return null;
}
/**
* (experimental) The name of the table.
*
* Default: - a name is generated
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getTableName() {
return null;
}
/**
* @return a {@link Builder} of {@link TableProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link TableProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.util.List tableColumns;
software.amazon.awscdk.services.redshift.alpha.TableDistStyle distStyle;
software.amazon.awscdk.RemovalPolicy removalPolicy;
software.amazon.awscdk.services.redshift.alpha.TableSortStyle sortStyle;
java.lang.String tableComment;
java.lang.String tableName;
software.amazon.awscdk.services.redshift.alpha.ICluster cluster;
java.lang.String databaseName;
software.amazon.awscdk.services.secretsmanager.ISecret adminUser;
/**
* Sets the value of {@link TableProps#getTableColumns}
* @param tableColumns The columns of the table. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@SuppressWarnings("unchecked")
public Builder tableColumns(java.util.List tableColumns) {
this.tableColumns = (java.util.List)tableColumns;
return this;
}
/**
* Sets the value of {@link TableProps#getDistStyle}
* @param distStyle The distribution style of the table.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder distStyle(software.amazon.awscdk.services.redshift.alpha.TableDistStyle distStyle) {
this.distStyle = distStyle;
return this;
}
/**
* Sets the value of {@link TableProps#getRemovalPolicy}
* @param removalPolicy The policy to apply when this resource is removed from the application.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder removalPolicy(software.amazon.awscdk.RemovalPolicy removalPolicy) {
this.removalPolicy = removalPolicy;
return this;
}
/**
* Sets the value of {@link TableProps#getSortStyle}
* @param sortStyle The sort style of the table.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder sortStyle(software.amazon.awscdk.services.redshift.alpha.TableSortStyle sortStyle) {
this.sortStyle = sortStyle;
return this;
}
/**
* Sets the value of {@link TableProps#getTableComment}
* @param tableComment A comment to attach to the table.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder tableComment(java.lang.String tableComment) {
this.tableComment = tableComment;
return this;
}
/**
* Sets the value of {@link TableProps#getTableName}
* @param tableName The name of the table.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder tableName(java.lang.String tableName) {
this.tableName = tableName;
return this;
}
/**
* Sets the value of {@link TableProps#getCluster}
* @param cluster The cluster containing the database. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder cluster(software.amazon.awscdk.services.redshift.alpha.ICluster cluster) {
this.cluster = cluster;
return this;
}
/**
* Sets the value of {@link TableProps#getDatabaseName}
* @param databaseName The name of the database. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder databaseName(java.lang.String databaseName) {
this.databaseName = databaseName;
return this;
}
/**
* Sets the value of {@link TableProps#getAdminUser}
* @param adminUser The secret containing credentials to a Redshift user with administrator privileges.
* Secret JSON schema: { username: string; password: string }.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder adminUser(software.amazon.awscdk.services.secretsmanager.ISecret adminUser) {
this.adminUser = adminUser;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link TableProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public TableProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link TableProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements TableProps {
private final java.util.List tableColumns;
private final software.amazon.awscdk.services.redshift.alpha.TableDistStyle distStyle;
private final software.amazon.awscdk.RemovalPolicy removalPolicy;
private final software.amazon.awscdk.services.redshift.alpha.TableSortStyle sortStyle;
private final java.lang.String tableComment;
private final java.lang.String tableName;
private final software.amazon.awscdk.services.redshift.alpha.ICluster cluster;
private final java.lang.String databaseName;
private final software.amazon.awscdk.services.secretsmanager.ISecret adminUser;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.tableColumns = software.amazon.jsii.Kernel.get(this, "tableColumns", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.redshift.alpha.Column.class)));
this.distStyle = software.amazon.jsii.Kernel.get(this, "distStyle", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.redshift.alpha.TableDistStyle.class));
this.removalPolicy = software.amazon.jsii.Kernel.get(this, "removalPolicy", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.RemovalPolicy.class));
this.sortStyle = software.amazon.jsii.Kernel.get(this, "sortStyle", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.redshift.alpha.TableSortStyle.class));
this.tableComment = software.amazon.jsii.Kernel.get(this, "tableComment", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.tableName = software.amazon.jsii.Kernel.get(this, "tableName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.cluster = software.amazon.jsii.Kernel.get(this, "cluster", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.redshift.alpha.ICluster.class));
this.databaseName = software.amazon.jsii.Kernel.get(this, "databaseName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.adminUser = software.amazon.jsii.Kernel.get(this, "adminUser", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.secretsmanager.ISecret.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.tableColumns = (java.util.List)java.util.Objects.requireNonNull(builder.tableColumns, "tableColumns is required");
this.distStyle = builder.distStyle;
this.removalPolicy = builder.removalPolicy;
this.sortStyle = builder.sortStyle;
this.tableComment = builder.tableComment;
this.tableName = builder.tableName;
this.cluster = java.util.Objects.requireNonNull(builder.cluster, "cluster is required");
this.databaseName = java.util.Objects.requireNonNull(builder.databaseName, "databaseName is required");
this.adminUser = builder.adminUser;
}
@Override
public final java.util.List getTableColumns() {
return this.tableColumns;
}
@Override
public final software.amazon.awscdk.services.redshift.alpha.TableDistStyle getDistStyle() {
return this.distStyle;
}
@Override
public final software.amazon.awscdk.RemovalPolicy getRemovalPolicy() {
return this.removalPolicy;
}
@Override
public final software.amazon.awscdk.services.redshift.alpha.TableSortStyle getSortStyle() {
return this.sortStyle;
}
@Override
public final java.lang.String getTableComment() {
return this.tableComment;
}
@Override
public final java.lang.String getTableName() {
return this.tableName;
}
@Override
public final software.amazon.awscdk.services.redshift.alpha.ICluster getCluster() {
return this.cluster;
}
@Override
public final java.lang.String getDatabaseName() {
return this.databaseName;
}
@Override
public final software.amazon.awscdk.services.secretsmanager.ISecret getAdminUser() {
return this.adminUser;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("tableColumns", om.valueToTree(this.getTableColumns()));
if (this.getDistStyle() != null) {
data.set("distStyle", om.valueToTree(this.getDistStyle()));
}
if (this.getRemovalPolicy() != null) {
data.set("removalPolicy", om.valueToTree(this.getRemovalPolicy()));
}
if (this.getSortStyle() != null) {
data.set("sortStyle", om.valueToTree(this.getSortStyle()));
}
if (this.getTableComment() != null) {
data.set("tableComment", om.valueToTree(this.getTableComment()));
}
if (this.getTableName() != null) {
data.set("tableName", om.valueToTree(this.getTableName()));
}
data.set("cluster", om.valueToTree(this.getCluster()));
data.set("databaseName", om.valueToTree(this.getDatabaseName()));
if (this.getAdminUser() != null) {
data.set("adminUser", om.valueToTree(this.getAdminUser()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-redshift-alpha.TableProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
TableProps.Jsii$Proxy that = (TableProps.Jsii$Proxy) o;
if (!tableColumns.equals(that.tableColumns)) return false;
if (this.distStyle != null ? !this.distStyle.equals(that.distStyle) : that.distStyle != null) return false;
if (this.removalPolicy != null ? !this.removalPolicy.equals(that.removalPolicy) : that.removalPolicy != null) return false;
if (this.sortStyle != null ? !this.sortStyle.equals(that.sortStyle) : that.sortStyle != null) return false;
if (this.tableComment != null ? !this.tableComment.equals(that.tableComment) : that.tableComment != null) return false;
if (this.tableName != null ? !this.tableName.equals(that.tableName) : that.tableName != null) return false;
if (!cluster.equals(that.cluster)) return false;
if (!databaseName.equals(that.databaseName)) return false;
return this.adminUser != null ? this.adminUser.equals(that.adminUser) : that.adminUser == null;
}
@Override
public final int hashCode() {
int result = this.tableColumns.hashCode();
result = 31 * result + (this.distStyle != null ? this.distStyle.hashCode() : 0);
result = 31 * result + (this.removalPolicy != null ? this.removalPolicy.hashCode() : 0);
result = 31 * result + (this.sortStyle != null ? this.sortStyle.hashCode() : 0);
result = 31 * result + (this.tableComment != null ? this.tableComment.hashCode() : 0);
result = 31 * result + (this.tableName != null ? this.tableName.hashCode() : 0);
result = 31 * result + (this.cluster.hashCode());
result = 31 * result + (this.databaseName.hashCode());
result = 31 * result + (this.adminUser != null ? this.adminUser.hashCode() : 0);
return result;
}
}
}