com.google.api.services.storagetransfer.v1.model

Class NotificationConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storagetransfer.v1.model.NotificationConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`.

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 Storage Transfer 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
NotificationConfig()

Method Summary

Modifier and Type	Method and Description
NotificationConfig	clone()
List<String>	getEventTypes() Event types for which a notification is desired.
String	getPayloadFormat() Required.
String	getPubsubTopic() Required.
NotificationConfig	set(String fieldName, Object value)
NotificationConfig	setEventTypes(List<String> eventTypes) Event types for which a notification is desired.
NotificationConfig	setPayloadFormat(String payloadFormat) Required.
NotificationConfig	setPubsubTopic(String pubsubTopic) Required.

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

NotificationConfig

public NotificationConfig()

Method Detail

getEventTypes

public List<String> getEventTypes()

Event types for which a notification is desired. If empty, send notifications for all event types.

Returns:

value or null for none

setEventTypes

public NotificationConfig setEventTypes(List<String> eventTypes)

Event types for which a notification is desired. If empty, send notifications for all event types.

Parameters:

eventTypes - eventTypes or null for none

getPayloadFormat

public String getPayloadFormat()

Required. The desired format of the notification message payloads.

Returns:

value or null for none

setPayloadFormat

public NotificationConfig setPayloadFormat(String payloadFormat)

Required. The desired format of the notification message payloads.

Parameters:

payloadFormat - payloadFormat or null for none

getPubsubTopic

public String getPubsubTopic()

Required. The `Topic.name` of the Pub/Sub topic to which to publish notifications. Must be of the format: `projects/{project}/topics/{topic}`. Not matching this format results in an INVALID_ARGUMENT error.

Returns:

value or null for none

setPubsubTopic

public NotificationConfig setPubsubTopic(String pubsubTopic)

Required. The `Topic.name` of the Pub/Sub topic to which to publish notifications. Must be of the format: `projects/{project}/topics/{topic}`. Not matching this format results in an INVALID_ARGUMENT error.

Parameters:

pubsubTopic - pubsubTopic or null for none

set

public NotificationConfig set(String fieldName,
                              Object value)

Overrides:

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

clone

public NotificationConfig clone()

Overrides:

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