software.amazon.awssdk.services.s3.model.TopicConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3 Show documentation
Show all versions of s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with
Amazon Simple Storage Service
/*
* 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.s3.model;
import java.io.Serializable;
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 software.amazon.awssdk.annotations.Generated;
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;
/**
*
* A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service
* (Amazon SNS) topic when Amazon S3 detects specified events.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TopicConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Id")
.getter(getter(TopicConfiguration::id))
.setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").unmarshallLocationName("Id")
.build()).build();
private static final SdkField TOPIC_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TopicArn")
.getter(getter(TopicConfiguration::topicArn))
.setter(setter(Builder::topicArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Topic")
.unmarshallLocationName("Topic").build()).build();
private static final SdkField> EVENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Events")
.getter(getter(TopicConfiguration::eventsAsStrings))
.setter(setter(Builder::eventsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Event")
.unmarshallLocationName("Event").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").unmarshallLocationName("member").build()).build())
.isFlattened(true).build()).build();
private static final SdkField FILTER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("Filter")
.getter(getter(TopicConfiguration::filter))
.setter(setter(Builder::filter))
.constructor(NotificationConfigurationFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter")
.unmarshallLocationName("Filter").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, TOPIC_ARN_FIELD,
EVENTS_FIELD, FILTER_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String topicArn;
private final List events;
private final NotificationConfigurationFilter filter;
private TopicConfiguration(BuilderImpl builder) {
this.id = builder.id;
this.topicArn = builder.topicArn;
this.events = builder.events;
this.filter = builder.filter;
}
/**
* Returns the value of the Id property for this object.
*
* @return The value of the Id property for this object.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects
* events of the specified type.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it
* detects events of the specified type.
*/
public final String topicArn() {
return topicArn;
}
/**
*
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the
* Amazon S3 User Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasEvents()} to see if a value was sent in this field.
*
*
* @return The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types
* in the Amazon S3 User Guide.
*/
public final List events() {
return EventListCopier.copyStringToEnum(events);
}
/**
* Returns true if the Events property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasEvents() {
return events != null && !(events instanceof SdkAutoConstructList);
}
/**
*
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the
* Amazon S3 User Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasEvents()} to see if a value was sent in this field.
*
*
* @return The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types
* in the Amazon S3 User Guide.
*/
public final List eventsAsStrings() {
return events;
}
/**
* Returns the value of the Filter property for this object.
*
* @return The value of the Filter property for this object.
*/
public final NotificationConfigurationFilter filter() {
return filter;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
hashCode = 31 * hashCode + Objects.hashCode(hasEvents() ? eventsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(filter());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TopicConfiguration)) {
return false;
}
TopicConfiguration other = (TopicConfiguration) obj;
return Objects.equals(id(), other.id()) && Objects.equals(topicArn(), other.topicArn())
&& hasEvents() == other.hasEvents() && Objects.equals(eventsAsStrings(), other.eventsAsStrings())
&& Objects.equals(filter(), other.filter());
}
/**
* 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("TopicConfiguration").add("Id", id()).add("TopicArn", topicArn())
.add("Events", hasEvents() ? eventsAsStrings() : null).add("Filter", filter()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "TopicArn":
return Optional.ofNullable(clazz.cast(topicArn()));
case "Events":
return Optional.ofNullable(clazz.cast(eventsAsStrings()));
case "Filter":
return Optional.ofNullable(clazz.cast(filter()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TopicConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Sets the value of the Id property for this object.
*
* @param id
* The new value for the Id property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects
* events of the specified type.
*
*
* @param topicArn
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it
* detects events of the specified type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder topicArn(String topicArn);
/**
*
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in
* the Amazon S3 User Guide.
*
*
* @param events
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event
* Types in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventsWithStrings(Collection events);
/**
*
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in
* the Amazon S3 User Guide.
*
*
* @param events
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event
* Types in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventsWithStrings(String... events);
/**
*
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in
* the Amazon S3 User Guide.
*
*
* @param events
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event
* Types in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder events(Collection events);
/**
*
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in
* the Amazon S3 User Guide.
*
*
* @param events
* The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event
* Types in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder events(Event... events);
/**
* Sets the value of the Filter property for this object.
*
* @param filter
* The new value for the Filter property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filter(NotificationConfigurationFilter filter);
/**
* Sets the value of the Filter property for this object.
*
* This is a convenience that creates an instance of the {@link NotificationConfigurationFilter.Builder}
* avoiding the need to create one manually via {@link NotificationConfigurationFilter#builder()}.
*
* When the {@link Consumer} completes, {@link NotificationConfigurationFilter.Builder#build()} is called
* immediately and its result is passed to {@link #filter(NotificationConfigurationFilter)}.
*
* @param filter
* a consumer that will call methods on {@link NotificationConfigurationFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filter(NotificationConfigurationFilter)
*/
default Builder filter(Consumer filter) {
return filter(NotificationConfigurationFilter.builder().applyMutation(filter).build());
}
}
static final class BuilderImpl implements Builder {
private String id;
private String topicArn;
private List events = DefaultSdkAutoConstructList.getInstance();
private NotificationConfigurationFilter filter;
private BuilderImpl() {
}
private BuilderImpl(TopicConfiguration model) {
id(model.id);
topicArn(model.topicArn);
eventsWithStrings(model.events);
filter(model.filter);
}
public final String getId() {
return id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final void setId(String id) {
this.id = id;
}
public final String getTopicArn() {
return topicArn;
}
@Override
public final Builder topicArn(String topicArn) {
this.topicArn = topicArn;
return this;
}
public final void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
public final Collection getEvents() {
if (events instanceof SdkAutoConstructList) {
return null;
}
return events;
}
@Override
public final Builder eventsWithStrings(Collection events) {
this.events = EventListCopier.copy(events);
return this;
}
@Override
@SafeVarargs
public final Builder eventsWithStrings(String... events) {
eventsWithStrings(Arrays.asList(events));
return this;
}
@Override
public final Builder events(Collection events) {
this.events = EventListCopier.copyEnumToString(events);
return this;
}
@Override
@SafeVarargs
public final Builder events(Event... events) {
events(Arrays.asList(events));
return this;
}
public final void setEvents(Collection events) {
this.events = EventListCopier.copy(events);
}
public final NotificationConfigurationFilter.Builder getFilter() {
return filter != null ? filter.toBuilder() : null;
}
@Override
public final Builder filter(NotificationConfigurationFilter filter) {
this.filter = filter;
return this;
}
public final void setFilter(NotificationConfigurationFilter.BuilderImpl filter) {
this.filter = filter != null ? filter.build() : null;
}
@Override
public TopicConfiguration build() {
return new TopicConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy