com.google.api.services.storage.model

Class Notification

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.Notification

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Notification
extends com.google.api.client.json.GenericJson

A subscription to receive Google PubSub notifications.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Storage JSON API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Modifier and Type	Method and Description
Notification	clone()
Map<String,String>	getCustomAttributes() An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
String	getEtag() HTTP 1.1 Entity tag for this subscription notification.
List<String>	getEventTypes() If present, only send notifications about listed event types.
String	getId() The ID of the notification.
String	getKind() The kind of item this is.
String	getObjectNamePrefix() If present, only apply this notification configuration to object names that begin with this prefix.
String	getPayloadFormat() The desired content of the Payload.
String	getSelfLink() The canonical URL of this notification.
String	getTopic() The Cloud PubSub topic to which this subscription publishes.
Notification	set(String fieldName, Object value)
Notification	setCustomAttributes(Map<String,String> customAttributes) An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
Notification	setEtag(String etag) HTTP 1.1 Entity tag for this subscription notification.
Notification	setEventTypes(List<String> eventTypes) If present, only send notifications about listed event types.
Notification	setId(String id) The ID of the notification.
Notification	setKind(String kind) The kind of item this is.
Notification	setObjectNamePrefix(String objectNamePrefix) If present, only apply this notification configuration to object names that begin with this prefix.
Notification	setPayloadFormat(String payloadFormat) The desired content of the Payload.
Notification	setSelfLink(String selfLink) The canonical URL of this notification.
Notification	setTopic(String topic) The Cloud PubSub topic to which this subscription publishes.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Notification

public Notification()

Method Detail

getCustomAttributes

public Map<String,String> getCustomAttributes()

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

Returns:

value or null for none

setCustomAttributes

public Notification setCustomAttributes(Map<String,String> customAttributes)

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

Parameters:

customAttributes - customAttributes or null for none

getEtag

public String getEtag()

HTTP 1.1 Entity tag for this subscription notification.

Returns:

value or null for none

setEtag

public Notification setEtag(String etag)

HTTP 1.1 Entity tag for this subscription notification.

Parameters:

etag - etag or null for none

getEventTypes

public List<String> getEventTypes()

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

Returns:

value or null for none

setEventTypes

public Notification setEventTypes(List<String> eventTypes)

If present, only send notifications about listed event types. If empty, sent notifications for all event types.

Parameters:

eventTypes - eventTypes or null for none

getId

public String getId()

The ID of the notification.

Returns:

value or null for none

setId

public Notification setId(String id)

The ID of the notification.

Parameters:

id - id or null for none

getKind

public String getKind()

The kind of item this is. For notifications, this is always storage#notification.

Returns:

value or null for none

setKind

public Notification setKind(String kind)

The kind of item this is. For notifications, this is always storage#notification.

Parameters:

kind - kind or null for none

getObjectNamePrefix

public String getObjectNamePrefix()

If present, only apply this notification configuration to object names that begin with this prefix.

Returns:

value or null for none

setObjectNamePrefix

public Notification setObjectNamePrefix(String objectNamePrefix)

If present, only apply this notification configuration to object names that begin with this prefix.

Parameters:

objectNamePrefix - objectNamePrefix or null for none

getPayloadFormat

public String getPayloadFormat()

The desired content of the Payload.

Returns:

value or null for none

setPayloadFormat

public Notification setPayloadFormat(String payloadFormat)

The desired content of the Payload.

Parameters:

payloadFormat - payloadFormat or null for none

getSelfLink

public String getSelfLink()

The canonical URL of this notification.

Returns:

value or null for none

setSelfLink

public Notification setSelfLink(String selfLink)

The canonical URL of this notification.

Parameters:

selfLink - selfLink or null for none

getTopic

public String getTopic()

The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'

Returns:

value or null for none

setTopic

public Notification setTopic(String topic)

The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'

Parameters:

topic - topic or null for none

set

public Notification set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Notification clone()

Overrides:

clone in class com.google.api.client.json.GenericJson