io.github.cdklabs.cdkecsserviceextensions.TopicSubscriptionProps Maven / Gradle / Ivy
Show all versions of cdk-ecs-service-extensions Show documentation
package io.github.cdklabs.cdkecsserviceextensions;
/**
* (experimental) The topic-specific settings for creating the queue subscriptions.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-19T00:29:44.795Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdkecsserviceextensions.$Module.class, fqn = "@aws-cdk-containers/ecs-service-extensions.TopicSubscriptionProps")
@software.amazon.jsii.Jsii.Proxy(TopicSubscriptionProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface TopicSubscriptionProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The SNS Topic to subscribe to.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull software.amazon.awscdk.services.sns.ITopic getTopic();
/**
* (deprecated) The user-provided queue to subscribe to the given topic.
*
* Default: none
*
* @deprecated use topicSubscriptionQueue
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Deprecated)
@Deprecated
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.sqs.IQueue getQueue() {
return null;
}
/**
* (experimental) The object representing topic-specific queue and corresponding queue delay fields to configure auto scaling.
*
* If not provided, the default eventsQueue will subscribe to the given topic.
*
* Default: none
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable io.github.cdklabs.cdkecsserviceextensions.SubscriptionQueue getTopicSubscriptionQueue() {
return null;
}
/**
* @return a {@link Builder} of {@link TopicSubscriptionProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link TopicSubscriptionProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
software.amazon.awscdk.services.sns.ITopic topic;
software.amazon.awscdk.services.sqs.IQueue queue;
io.github.cdklabs.cdkecsserviceextensions.SubscriptionQueue topicSubscriptionQueue;
/**
* Sets the value of {@link TopicSubscriptionProps#getTopic}
* @param topic The SNS Topic to subscribe to. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder topic(software.amazon.awscdk.services.sns.ITopic topic) {
this.topic = topic;
return this;
}
/**
* Sets the value of {@link TopicSubscriptionProps#getQueue}
* @param queue The user-provided queue to subscribe to the given topic.
* @return {@code this}
* @deprecated use `topicSubscriptionQueue`
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Deprecated)
@Deprecated
public Builder queue(software.amazon.awscdk.services.sqs.IQueue queue) {
this.queue = queue;
return this;
}
/**
* Sets the value of {@link TopicSubscriptionProps#getTopicSubscriptionQueue}
* @param topicSubscriptionQueue The object representing topic-specific queue and corresponding queue delay fields to configure auto scaling.
* If not provided, the default eventsQueue will subscribe to the given topic.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder topicSubscriptionQueue(io.github.cdklabs.cdkecsserviceextensions.SubscriptionQueue topicSubscriptionQueue) {
this.topicSubscriptionQueue = topicSubscriptionQueue;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link TopicSubscriptionProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public TopicSubscriptionProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link TopicSubscriptionProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements TopicSubscriptionProps {
private final software.amazon.awscdk.services.sns.ITopic topic;
private final software.amazon.awscdk.services.sqs.IQueue queue;
private final io.github.cdklabs.cdkecsserviceextensions.SubscriptionQueue topicSubscriptionQueue;
/**
* 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.topic = software.amazon.jsii.Kernel.get(this, "topic", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.sns.ITopic.class));
this.queue = software.amazon.jsii.Kernel.get(this, "queue", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.sqs.IQueue.class));
this.topicSubscriptionQueue = software.amazon.jsii.Kernel.get(this, "topicSubscriptionQueue", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdkecsserviceextensions.SubscriptionQueue.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.topic = java.util.Objects.requireNonNull(builder.topic, "topic is required");
this.queue = builder.queue;
this.topicSubscriptionQueue = builder.topicSubscriptionQueue;
}
@Override
public final software.amazon.awscdk.services.sns.ITopic getTopic() {
return this.topic;
}
@Override
public final software.amazon.awscdk.services.sqs.IQueue getQueue() {
return this.queue;
}
@Override
public final io.github.cdklabs.cdkecsserviceextensions.SubscriptionQueue getTopicSubscriptionQueue() {
return this.topicSubscriptionQueue;
}
@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("topic", om.valueToTree(this.getTopic()));
if (this.getQueue() != null) {
data.set("queue", om.valueToTree(this.getQueue()));
}
if (this.getTopicSubscriptionQueue() != null) {
data.set("topicSubscriptionQueue", om.valueToTree(this.getTopicSubscriptionQueue()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk-containers/ecs-service-extensions.TopicSubscriptionProps"));
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;
TopicSubscriptionProps.Jsii$Proxy that = (TopicSubscriptionProps.Jsii$Proxy) o;
if (!topic.equals(that.topic)) return false;
if (this.queue != null ? !this.queue.equals(that.queue) : that.queue != null) return false;
return this.topicSubscriptionQueue != null ? this.topicSubscriptionQueue.equals(that.topicSubscriptionQueue) : that.topicSubscriptionQueue == null;
}
@Override
public final int hashCode() {
int result = this.topic.hashCode();
result = 31 * result + (this.queue != null ? this.queue.hashCode() : 0);
result = 31 * result + (this.topicSubscriptionQueue != null ? this.topicSubscriptionQueue.hashCode() : 0);
return result;
}
}
}