com.ibm.cloud.objectstorage.services.s3.model

Class BucketNotificationConfiguration

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.BucketNotificationConfiguration

All Implemented Interfaces:

Serializable

public class BucketNotificationConfiguration
extends Object
implements Serializable

Represents a bucket's notification configuration. The notification configuration is used to control reception of notifications for specific events for Amazon S3 buckets.

Using SNS as the delivery service, the notification configuration of an Amazon S3 bucket provides near real-time notifications of events the user is interested in. Notification is turned on by enabling configuration on a bucket, specifying the events and the SNS topic. This configuration can only be turned on by the bucket owner.

If a notification configuration already exists for the specified bucket, the new notification configuration will replace the existing notification configuration. To remove a notification configuration, pass an an empty configuration directly to AmazonS3#setBucketNotificationConfiguration(String,BucketNotificationConfiguration).

Note: Currently buckets may only have a single event and topic configuration.

See Also:

AmazonS3#getBucketNotificationConfiguration(String), AmazonS3#setBucketNotificationConfiguration(String, BucketNotificationConfiguration), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BucketNotificationConfiguration.TopicConfiguration Deprecated. Use TopicConfiguration instead

Constructor Summary

Constructors

Constructor and Description
BucketNotificationConfiguration() Creates a new bucket notification configuration.
BucketNotificationConfiguration(Collection<BucketNotificationConfiguration.TopicConfiguration> topicConfigurations) Deprecated.
BucketNotificationConfiguration(String name, NotificationConfiguration notificationConfiguration) Creates a new bucket notification configuration with the given configuration.

Method Summary

Modifier and Type	Method and Description
BucketNotificationConfiguration	addConfiguration(String name, NotificationConfiguration notificationConfiguration) Adds the given notification configuration to the BucketNotificationConfiguration object
NotificationConfiguration	getConfigurationByName(String name) Returns the notification configuration for the given name.
Map<String,NotificationConfiguration>	getConfigurations() Returns all the notification configurations associated with the Amazon S3 bucket.
List<BucketNotificationConfiguration.TopicConfiguration>	getTopicConfigurations() Deprecated.
NotificationConfiguration	removeConfiguration(String name) Removes the notification configuration for the given name in the BucketNotificationConfiguration object.
void	setConfigurations(Map<String,NotificationConfiguration> configurations) Sets the given notification configurations in this BucketNotificationConfiguration object.
void	setTopicConfigurations(Collection<BucketNotificationConfiguration.TopicConfiguration> topicConfigurations) Deprecated.
String	toString() Enables delivery of all bucket events to Amazon EventBridge.
BucketNotificationConfiguration	withNotificationConfiguration(Map<String,NotificationConfiguration> notificationConfiguration) Sets the given notification configurations and returns this object.
BucketNotificationConfiguration	withTopicConfigurations(BucketNotificationConfiguration.TopicConfiguration... topicConfigurations) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BucketNotificationConfiguration

public BucketNotificationConfiguration()

Creates a new bucket notification configuration. By default, the newly created configuration is empty.

Passing the new configuration directly to AmazonS3#setBucketNotificationConfiguration(String,BucketNotificationConfiguration) will remove any existing bucket notification configuration.

See Also:

BucketNotificationConfiguration(Collection)

BucketNotificationConfiguration

public BucketNotificationConfiguration(String name,
                                       NotificationConfiguration notificationConfiguration)

Creates a new bucket notification configuration with the given configuration.

Parameters:

name - the name for the configuration

notificationConfiguration - the notification configuration for the Amazon S3 bucket.

BucketNotificationConfiguration

public BucketNotificationConfiguration(Collection<BucketNotificationConfiguration.TopicConfiguration> topicConfigurations)

Deprecated.

Creates a new bucket notification configuration containing the specified TopicConfigurations.

Passing the new configuration directly to AmazonS3#setBucketNotificationConfiguration(String,BucketNotificationConfiguration) will set the bucket's notification configuration and overwrite any existing configuration.

See Also:

BucketNotificationConfiguration(String, NotificationConfiguration)

Method Detail

withNotificationConfiguration

public BucketNotificationConfiguration withNotificationConfiguration(Map<String,NotificationConfiguration> notificationConfiguration)

Sets the given notification configurations and returns this object.

Parameters:

notificationConfiguration - the notification configurations to set

Returns:

The updated BucketNotificationConfiguration object.

addConfiguration

public BucketNotificationConfiguration addConfiguration(String name,
                                                        NotificationConfiguration notificationConfiguration)

Adds the given notification configuration to the BucketNotificationConfiguration object

Parameters:

name - the name of the configuration

notificationConfiguration - the notification configuration for the Amazon S3 bucket.

Returns:

The updated BucketNotificationConfiguration object.

getConfigurations

public Map<String,NotificationConfiguration> getConfigurations()

Returns all the notification configurations associated with the Amazon S3 bucket.

setConfigurations

public void setConfigurations(Map<String,NotificationConfiguration> configurations)

Sets the given notification configurations in this BucketNotificationConfiguration object.

Parameters:

configurations - the notification configurations to set

getConfigurationByName

public NotificationConfiguration getConfigurationByName(String name)

Returns the notification configuration for the given name.

Parameters:

name - the name of the notification configuration

Returns:

NotificationConfiguration associated with the given name.

removeConfiguration

public NotificationConfiguration removeConfiguration(String name)

Removes the notification configuration for the given name in the BucketNotificationConfiguration object.

Pass the updated BucketNotificationConfiguration to AmazonS3#setBucketNotificationConfiguration(String,BucketNotificationConfiguration) to update the configuration in Amazon S3 for the bucket.

Parameters:

name - the name of the notification configuration

Returns:

NotificationConfiguration associated with the given name.

withTopicConfigurations

public BucketNotificationConfiguration withTopicConfigurations(BucketNotificationConfiguration.TopicConfiguration... topicConfigurations)

Deprecated.

Sets the BucketNotificationConfiguration.TopicConfiguration TopicConfigurations and returns this object, enabling additional method calls to be chained together.

Calling this method will overwrite any previously set TopicConfigurations for this object.

Parameters:

topicConfigurations - A set of topic configurations.

Returns:

The updated BucketNotificationConfiguration object, enabling additional method calls to be chained together.

See Also:

BucketNotificationConfiguration.withNotificationConfiguration(Map)

setTopicConfigurations

public void setTopicConfigurations(Collection<BucketNotificationConfiguration.TopicConfiguration> topicConfigurations)

Deprecated.

Sets the BucketNotificationConfiguration.TopicConfiguration.

Calling this method will overwrite any previously set TopicConfigurations for this object.

Parameters:

topicConfigurations - A collection of topic configurations.

See Also:

BucketNotificationConfiguration.setConfigurations(Map)

getTopicConfigurations

public List<BucketNotificationConfiguration.TopicConfiguration> getTopicConfigurations()

Deprecated.

Gets the list of BucketNotificationConfiguration.TopicConfiguration objects contained in this object. This method may return an empty list if no TopicConfiguration objects are present.

This method is deprecated and will not return all the notification configuration associated with the Amazon S3 bucket. To retrieve all the configuration use @see BucketNotificationConfiguration#getConfigurations()

Returns:

The list of TopicConfiguration objects contained in this object. May return an empty list.

See Also:

BucketNotificationConfiguration.getConfigurations()

toString

public String toString()

Enables delivery of all bucket events to Amazon EventBridge.

Overrides:

toString in class Object