software.amazon.awscdk.services.glue.alpha.SparkUIProps Maven / Gradle / Ivy
Show all versions of glue-alpha Show documentation
package software.amazon.awscdk.services.glue.alpha;
/**
* (experimental) Properties for enabling Spark UI monitoring feature for Spark-based Glue jobs.
*
* Example:
*
*
* Job.Builder.create(this, "EnableSparkUI")
* .jobName("EtlJobWithSparkUIPrefix")
* .sparkUI(SparkUIProps.builder()
* .enabled(true)
* .build())
* .executable(JobExecutable.pythonEtl(PythonSparkJobExecutableProps.builder()
* .glueVersion(GlueVersion.V3_0)
* .pythonVersion(PythonVersion.THREE)
* .script(Code.fromAsset(join(__dirname, "job-script", "hello_world.py")))
* .build()))
* .build();
*
*
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.99.0 (build 8f757e4)", date = "2024-06-13T18:49:27.694Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.glue.alpha.$Module.class, fqn = "@aws-cdk/aws-glue-alpha.SparkUIProps")
@software.amazon.jsii.Jsii.Proxy(SparkUIProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface SparkUIProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) Enable Spark UI.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.Boolean getEnabled();
/**
* (experimental) The bucket where the Glue job stores the logs.
*
* Default: - a new bucket will be created.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.s3.IBucket getBucket() {
return null;
}
/**
* (experimental) The path inside the bucket (objects prefix) where the Glue job stores the logs.
*
* Use format 'foo/bar/'
*
* Default: - the logs will be written at the root of the bucket
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getPrefix() {
return null;
}
/**
* @return a {@link Builder} of {@link SparkUIProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link SparkUIProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Boolean enabled;
software.amazon.awscdk.services.s3.IBucket bucket;
java.lang.String prefix;
/**
* Sets the value of {@link SparkUIProps#getEnabled}
* @param enabled Enable Spark UI. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder enabled(java.lang.Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Sets the value of {@link SparkUIProps#getBucket}
* @param bucket The bucket where the Glue job stores the logs.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder bucket(software.amazon.awscdk.services.s3.IBucket bucket) {
this.bucket = bucket;
return this;
}
/**
* Sets the value of {@link SparkUIProps#getPrefix}
* @param prefix The path inside the bucket (objects prefix) where the Glue job stores the logs.
* Use format 'foo/bar/'
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder prefix(java.lang.String prefix) {
this.prefix = prefix;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link SparkUIProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public SparkUIProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link SparkUIProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SparkUIProps {
private final java.lang.Boolean enabled;
private final software.amazon.awscdk.services.s3.IBucket bucket;
private final java.lang.String prefix;
/**
* 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.enabled = software.amazon.jsii.Kernel.get(this, "enabled", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.bucket = software.amazon.jsii.Kernel.get(this, "bucket", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.s3.IBucket.class));
this.prefix = software.amazon.jsii.Kernel.get(this, "prefix", software.amazon.jsii.NativeType.forClass(java.lang.String.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.enabled = java.util.Objects.requireNonNull(builder.enabled, "enabled is required");
this.bucket = builder.bucket;
this.prefix = builder.prefix;
}
@Override
public final java.lang.Boolean getEnabled() {
return this.enabled;
}
@Override
public final software.amazon.awscdk.services.s3.IBucket getBucket() {
return this.bucket;
}
@Override
public final java.lang.String getPrefix() {
return this.prefix;
}
@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("enabled", om.valueToTree(this.getEnabled()));
if (this.getBucket() != null) {
data.set("bucket", om.valueToTree(this.getBucket()));
}
if (this.getPrefix() != null) {
data.set("prefix", om.valueToTree(this.getPrefix()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-glue-alpha.SparkUIProps"));
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;
SparkUIProps.Jsii$Proxy that = (SparkUIProps.Jsii$Proxy) o;
if (!enabled.equals(that.enabled)) return false;
if (this.bucket != null ? !this.bucket.equals(that.bucket) : that.bucket != null) return false;
return this.prefix != null ? this.prefix.equals(that.prefix) : that.prefix == null;
}
@Override
public final int hashCode() {
int result = this.enabled.hashCode();
result = 31 * result + (this.bucket != null ? this.bucket.hashCode() : 0);
result = 31 * result + (this.prefix != null ? this.prefix.hashCode() : 0);
return result;
}
}
}