Notification (Cloud Storage JSON API v1 (Rev. 141) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.storage.model.Notification

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Notification()

Constructors
Constructor and Description
`Notification()`

Method Summary

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.lang.String getEtag()
```
    HTTP 1.1 Entity tag for this subscription notification.
    
    Returns:
    
    value or null for none
  - setEtag
```
public Notification setEtag(java.lang.String etag)
```
    HTTP 1.1 Entity tag for this subscription notification.
    
    Parameters:
    
    etag - etag or null for none
  - getEventTypes
```
public java.util.List<java.lang.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(java.util.List<java.lang.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 java.lang.String getId()
```
    The ID of the notification.
    
    Returns:
    
    value or null for none
  - setId
```
public Notification setId(java.lang.String id)
```
    The ID of the notification.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public java.lang.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(java.lang.String kind)
```
    The kind of item this is. For notifications, this is always storage#notification.
    
    Parameters:
    
    kind - kind or null for none
  - getObjectNamePrefix
```
public java.lang.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(java.lang.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 java.lang.String getPayloadFormat()
```
    The desired content of the Payload.
    
    Returns:
    
    value or null for none
  - setPayloadFormat
```
public Notification setPayloadFormat(java.lang.String payloadFormat)
```
    The desired content of the Payload.
    
    Parameters:
    
    payloadFormat - payloadFormat or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    The canonical URL of this notification.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Notification setSelfLink(java.lang.String selfLink)
```
    The canonical URL of this notification.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getTopic
```
public java.lang.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(java.lang.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(java.lang.String fieldName,
                        java.lang.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

Cloud Storage JSON API v1 (revision 141)

Class Notification

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Notification

Method Detail

getCustomAttributes

setCustomAttributes

getEtag

setEtag

getEventTypes

setEventTypes

getId

setId

getKind

setKind

getObjectNamePrefix

setObjectNamePrefix

getPayloadFormat

setPayloadFormat

getSelfLink

setSelfLink

getTopic

setTopic

set

clone