io.github.cdklabs.cdk.appflow.S3Catalog Maven / Gradle / Ivy
package io.github.cdklabs.cdk.appflow;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-11T10:39:08.271Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.appflow.$Module.class, fqn = "@cdklabs/cdk-appflow.S3Catalog")
@software.amazon.jsii.Jsii.Proxy(S3Catalog.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface S3Catalog extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The AWS Glue database that will contain the tables created when the flow executes.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.glue.alpha.IDatabase getDatabase();
/**
* (experimental) The prefix for the tables created in the AWS Glue database.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getTablePrefix();
/**
* (experimental) The IAM Role that will be used for data catalog operations.
*
* Default: - A new role will be created
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.iam.IRole getRole() {
return null;
}
/**
* @return a {@link Builder} of {@link S3Catalog}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link S3Catalog}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
software.amazon.awscdk.services.glue.alpha.IDatabase database;
java.lang.String tablePrefix;
software.amazon.awscdk.services.iam.IRole role;
/**
* Sets the value of {@link S3Catalog#getDatabase}
* @param database The AWS Glue database that will contain the tables created when the flow executes. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder database(software.amazon.awscdk.services.glue.alpha.IDatabase database) {
this.database = database;
return this;
}
/**
* Sets the value of {@link S3Catalog#getTablePrefix}
* @param tablePrefix The prefix for the tables created in the AWS Glue database. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder tablePrefix(java.lang.String tablePrefix) {
this.tablePrefix = tablePrefix;
return this;
}
/**
* Sets the value of {@link S3Catalog#getRole}
* @param role The IAM Role that will be used for data catalog operations.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder role(software.amazon.awscdk.services.iam.IRole role) {
this.role = role;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link S3Catalog}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public S3Catalog build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link S3Catalog}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements S3Catalog {
private final software.amazon.awscdk.services.glue.alpha.IDatabase database;
private final java.lang.String tablePrefix;
private final software.amazon.awscdk.services.iam.IRole role;
/**
* 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.database = software.amazon.jsii.Kernel.get(this, "database", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.glue.alpha.IDatabase.class));
this.tablePrefix = software.amazon.jsii.Kernel.get(this, "tablePrefix", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.role = software.amazon.jsii.Kernel.get(this, "role", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.iam.IRole.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.database = java.util.Objects.requireNonNull(builder.database, "database is required");
this.tablePrefix = java.util.Objects.requireNonNull(builder.tablePrefix, "tablePrefix is required");
this.role = builder.role;
}
@Override
public final software.amazon.awscdk.services.glue.alpha.IDatabase getDatabase() {
return this.database;
}
@Override
public final java.lang.String getTablePrefix() {
return this.tablePrefix;
}
@Override
public final software.amazon.awscdk.services.iam.IRole getRole() {
return this.role;
}
@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("database", om.valueToTree(this.getDatabase()));
data.set("tablePrefix", om.valueToTree(this.getTablePrefix()));
if (this.getRole() != null) {
data.set("role", om.valueToTree(this.getRole()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@cdklabs/cdk-appflow.S3Catalog"));
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;
S3Catalog.Jsii$Proxy that = (S3Catalog.Jsii$Proxy) o;
if (!database.equals(that.database)) return false;
if (!tablePrefix.equals(that.tablePrefix)) return false;
return this.role != null ? this.role.equals(that.role) : that.role == null;
}
@Override
public final int hashCode() {
int result = this.database.hashCode();
result = 31 * result + (this.tablePrefix.hashCode());
result = 31 * result + (this.role != null ? this.role.hashCode() : 0);
return result;
}
}
}