Package com.google.cloud.storage

Class NotificationInfo

java.lang.Object

com.google.cloud.storage.NotificationInfo

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Notification

public class NotificationInfo
extends Object
implements Serializable

The class representing Pub/Sub Notification metadata for the Storage.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotificationInfo.Builder	Builder for NotificationInfo.
static class	NotificationInfo.BuilderImpl	Builder for NotificationInfo.
static enum	NotificationInfo.EventType
static enum	NotificationInfo.PayloadFormat

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,String>	getCustomAttributes()	Returns the list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
String	getEtag()	Returns HTTP 1.1 Entity tag for the notification.
List<NotificationInfo.EventType>	getEventTypes()	Returns the events that trigger a notification to be sent.
String	getNotificationId()	Returns the service-generated id for the notification.
String	getObjectNamePrefix()	Returns the object name prefix for which this notification configuration applies.
NotificationInfo.PayloadFormat	getPayloadFormat()	Returns the desired content of the Payload.
String	getSelfLink()	Returns the canonical URI of this topic as a string.
String	getTopic()	Returns the topic in Pub/Sub that receives notifications.
int	hashCode()
static NotificationInfo.Builder	newBuilder(String topic)	Creates a NotificationInfo object for the provided topic.
static NotificationInfo	of(String topic)	Creates a NotificationInfo object for the provided topic.
NotificationInfo.Builder	toBuilder()	Returns a builder for the current notification.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getNotificationId

public String getNotificationId()

Returns the service-generated id for the notification.

getTopic

public String getTopic()

Returns the topic in Pub/Sub that receives notifications.

getSelfLink

public String getSelfLink()

Returns the canonical URI of this topic as a string.

getPayloadFormat

public NotificationInfo.PayloadFormat getPayloadFormat()

Returns the desired content of the Payload.

getObjectNamePrefix

public String getObjectNamePrefix()

Returns the object name prefix for which this notification configuration applies.

getEtag

public String getEtag()

Returns HTTP 1.1 Entity tag for the notification. See Entity Tags

getEventTypes

public List<NotificationInfo.EventType> getEventTypes()

Returns the events that trigger a notification to be sent. If empty, notifications are triggered by any event. See Event types to get list of available events.

getCustomAttributes

public Map<String,String> getCustomAttributes()

Returns the list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static NotificationInfo of(String topic)

Creates a NotificationInfo object for the provided topic.

Example of creating the NotificationInfo object:

 String topic = "projects/myProject/topics/myTopic"
 NotificationInfo notificationInfo = NotificationInfo.of(topic)
 

Parameters:

topic - a string in the format "projects/{project}/topics/{topic}"

newBuilder

public static NotificationInfo.Builder newBuilder(String topic)

Creates a NotificationInfo object for the provided topic.

Parameters:

topic - a string in the format "projects/{project}/topics/{topic}"

toBuilder

public NotificationInfo.Builder toBuilder()

Returns a builder for the current notification.