software.amazon.awssdk.services.rds.model.CreateEventSubscriptionRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateEventSubscriptionRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField SUBSCRIPTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SubscriptionName").getter(getter(CreateEventSubscriptionRequest::subscriptionName))
.setter(setter(Builder::subscriptionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubscriptionName").build()).build();
private static final SdkField SNS_TOPIC_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnsTopicArn").getter(getter(CreateEventSubscriptionRequest::snsTopicArn))
.setter(setter(Builder::snsTopicArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnsTopicArn").build()).build();
private static final SdkField SOURCE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceType").getter(getter(CreateEventSubscriptionRequest::sourceType))
.setter(setter(Builder::sourceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceType").build()).build();
private static final SdkField> EVENT_CATEGORIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EventCategories")
.getter(getter(CreateEventSubscriptionRequest::eventCategories))
.setter(setter(Builder::eventCategories))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventCategories").build(),
ListTrait
.builder()
.memberLocationName("EventCategory")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("EventCategory").build()).build()).build()).build();
private static final SdkField> SOURCE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SourceIds")
.getter(getter(CreateEventSubscriptionRequest::sourceIds))
.setter(setter(Builder::sourceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceIds").build(),
ListTrait
.builder()
.memberLocationName("SourceId")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("SourceId").build()).build()).build()).build();
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Enabled").getter(getter(CreateEventSubscriptionRequest::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Enabled").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateEventSubscriptionRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName("Tag")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Tag").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SUBSCRIPTION_NAME_FIELD,
SNS_TOPIC_ARN_FIELD, SOURCE_TYPE_FIELD, EVENT_CATEGORIES_FIELD, SOURCE_IDS_FIELD, ENABLED_FIELD, TAGS_FIELD));
private final String subscriptionName;
private final String snsTopicArn;
private final String sourceType;
private final List eventCategories;
private final List sourceIds;
private final Boolean enabled;
private final List tags;
private CreateEventSubscriptionRequest(BuilderImpl builder) {
super(builder);
this.subscriptionName = builder.subscriptionName;
this.snsTopicArn = builder.snsTopicArn;
this.sourceType = builder.sourceType;
this.eventCategories = builder.eventCategories;
this.sourceIds = builder.sourceIds;
this.enabled = builder.enabled;
this.tags = builder.tags;
}
/**
*
* The name of the subscription.
*
*
* Constraints: The name must be less than 255 characters.
*
*
* @return The name of the subscription.
*
* Constraints: The name must be less than 255 characters.
*/
public final String subscriptionName() {
return subscriptionName;
}
/**
*
* The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN
* when you create a topic and subscribe to it.
*
*
*
* RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO
* topics) in the Amazon Simple Notification Service Developer Guide.
*
*
*
* @return The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates
* the ARN when you create a topic and subscribe to it.
*
* RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication
* (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
*
*/
public final String snsTopicArn() {
return snsTopicArn;
}
/**
*
* The type of source that is generating the events. For example, if you want to be notified of events generated by
* a DB instance, you set this parameter to db-instance
. For RDS Proxy events, specify
* db-proxy
. If this value isn't specified, all events are returned.
*
*
* Valid Values:
* db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
*
*
* @return The type of source that is generating the events. For example, if you want to be notified of events
* generated by a DB instance, you set this parameter to db-instance
. For RDS Proxy events,
* specify db-proxy
. If this value isn't specified, all events are returned.
*
* Valid Values:
* db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
*/
public final String sourceType() {
return sourceType;
}
/**
* For responses, this returns true if the service returned a value for the EventCategories property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasEventCategories() {
return eventCategories != null && !(eventCategories instanceof SdkAutoConstructList);
}
/**
*
* A list of event categories for a particular source type (SourceType
) that you want to subscribe to.
* You can see a list of the categories for a given source type in the
* "Amazon RDS event categories and event messages" section of the Amazon RDS User
* Guide or the Amazon Aurora
* User Guide . You can also see this list by using the DescribeEventCategories
operation.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasEventCategories} method.
*
*
* @return A list of event categories for a particular source type (SourceType
) that you want to
* subscribe to. You can see a list of the categories for a given source type in the
* "Amazon RDS event categories and event messages" section of the Amazon RDS
* User Guide or the Amazon
* Aurora User Guide . You can also see this list by using the DescribeEventCategories
* operation.
*/
public final List eventCategories() {
return eventCategories;
}
/**
* For responses, this returns true if the service returned a value for the SourceIds property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasSourceIds() {
return sourceIds != null && !(sourceIds instanceof SdkAutoConstructList);
}
/**
*
* The list of identifiers of the event sources for which events are returned. If not specified, then all sources
* are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits,
* and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
*
*
* Constraints:
*
*
* -
*
* If SourceIds
are supplied, SourceType
must also be provided.
*
*
* -
*
* If the source type is a DB instance, a DBInstanceIdentifier
value must be supplied.
*
*
* -
*
* If the source type is a DB cluster, a DBClusterIdentifier
value must be supplied.
*
*
* -
*
* If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
*
*
* -
*
* If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
*
*
* -
*
* If the source type is a DB snapshot, a DBSnapshotIdentifier
value must be supplied.
*
*
* -
*
* If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
value must be supplied.
*
*
* -
*
* If the source type is an RDS Proxy, a DBProxyName
value must be supplied.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSourceIds} method.
*
*
* @return The list of identifiers of the event sources for which events are returned. If not specified, then all
* sources are included in the response. An identifier must begin with a letter and must contain only ASCII
* letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
*
* Constraints:
*
*
* -
*
* If SourceIds
are supplied, SourceType
must also be provided.
*
*
* -
*
* If the source type is a DB instance, a DBInstanceIdentifier
value must be supplied.
*
*
* -
*
* If the source type is a DB cluster, a DBClusterIdentifier
value must be supplied.
*
*
* -
*
* If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
*
*
* -
*
* If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
*
*
* -
*
* If the source type is a DB snapshot, a DBSnapshotIdentifier
value must be supplied.
*
*
* -
*
* If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier
value must be
* supplied.
*
*
* -
*
* If the source type is an RDS Proxy, a DBProxyName
value must be supplied.
*
*
*/
public final List sourceIds() {
return sourceIds;
}
/**
*
* Specifies whether to activate the subscription. If the event notification subscription isn't activated, the
* subscription is created but not active.
*
*
* @return Specifies whether to activate the subscription. If the event notification subscription isn't activated,
* the subscription is created but not active.
*/
public final Boolean enabled() {
return enabled;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
* Returns the value of the Tags property for this object.
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return The value of the Tags property for this object.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(subscriptionName());
hashCode = 31 * hashCode + Objects.hashCode(snsTopicArn());
hashCode = 31 * hashCode + Objects.hashCode(sourceType());
hashCode = 31 * hashCode + Objects.hashCode(hasEventCategories() ? eventCategories() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSourceIds() ? sourceIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateEventSubscriptionRequest)) {
return false;
}
CreateEventSubscriptionRequest other = (CreateEventSubscriptionRequest) obj;
return Objects.equals(subscriptionName(), other.subscriptionName()) && Objects.equals(snsTopicArn(), other.snsTopicArn())
&& Objects.equals(sourceType(), other.sourceType()) && hasEventCategories() == other.hasEventCategories()
&& Objects.equals(eventCategories(), other.eventCategories()) && hasSourceIds() == other.hasSourceIds()
&& Objects.equals(sourceIds(), other.sourceIds()) && Objects.equals(enabled(), other.enabled())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("CreateEventSubscriptionRequest").add("SubscriptionName", subscriptionName())
.add("SnsTopicArn", snsTopicArn()).add("SourceType", sourceType())
.add("EventCategories", hasEventCategories() ? eventCategories() : null)
.add("SourceIds", hasSourceIds() ? sourceIds() : null).add("Enabled", enabled())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SubscriptionName":
return Optional.ofNullable(clazz.cast(subscriptionName()));
case "SnsTopicArn":
return Optional.ofNullable(clazz.cast(snsTopicArn()));
case "SourceType":
return Optional.ofNullable(clazz.cast(sourceType()));
case "EventCategories":
return Optional.ofNullable(clazz.cast(eventCategories()));
case "SourceIds":
return Optional.ofNullable(clazz.cast(sourceIds()));
case "Enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function