Class NotificationInfo (2.20.2)

Stay organized with collections Save and categorize content based on your preferences.
public class NotificationInfo implements Serializable

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

Inheritance

Object > NotificationInfo

Implements

Serializable

Static Methods

newBuilder(String topic)

public static NotificationInfo.Builder newBuilder(String topic)

Creates a NotificationInfo object for the provided topic.

Parameter
NameDescription
topicString

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

Returns
TypeDescription
NotificationInfo.Builder

of(String topic)

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)
 
Parameter
NameDescription
topicString

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

Returns
TypeDescription
NotificationInfo

Methods

equals(Object o)

public boolean equals(Object o)
Parameter
NameDescription
oObject
Returns
TypeDescription
boolean
Overrides

getCustomAttributes()

public Map<String,String> getCustomAttributes()

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

Returns
TypeDescription
Map<String,String>

getEtag()

public String getEtag()

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

Returns
TypeDescription
String

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.

Returns
TypeDescription
List<EventType>

getNotificationId()

public String getNotificationId()

Returns the service-generated id for the notification.

Returns
TypeDescription
String

getObjectNamePrefix()

public String getObjectNamePrefix()

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

Returns
TypeDescription
String

getPayloadFormat()

public NotificationInfo.PayloadFormat getPayloadFormat()

Returns the desired content of the Payload.

Returns
TypeDescription