Class NotificationInfo (2.24.0)

public class NotificationInfo implements Serializable

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

Inheritance

Object > NotificationInfo

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder(String topic)

public static NotificationInfo.Builder newBuilder(String topic)

Creates a NotificationInfo object for the provided topic.

Parameter
Name	Description
`topic`	`String` a string in the format "projects/{project}/topics/{topic}"

Returns
Type	Description
`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
Name	Description
`topic`	`String` a string in the format "projects/{project}/topics/{topic}"

Returns
Type	Description
`NotificationInfo`

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
`o`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

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
Type	Description
`Map<String,String>`

getEtag()

public String getEtag()

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

Returns
Type	Description
`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
Type	Description
`List<EventType>`

getNotificationId()

public String getNotificationId()

Returns the service-generated id for the notification.

Returns
Type	Description
`String`

getObjectNamePrefix()

public String getObjectNamePrefix()

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

Returns
Type	Description
`String`

getPayloadFormat()

public NotificationInfo.PayloadFormat getPayloadFormat()

Returns the desired content of the Payload.

Returns
Type	Description
`NotificationInfo.PayloadFormat`

getSelfLink()

public String getSelfLink()

Returns the canonical URI of this topic as a string.

Returns
Type	Description
`String`

getTopic()

public String getTopic()

Returns the topic in Pub/Sub that receives notifications.

Returns
Type	Description
`String`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

toBuilder()

public NotificationInfo.Builder toBuilder()

Returns a builder for the current notification.

Returns
Type	Description
`NotificationInfo.Builder`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()