com.google.api.services.pubsub.model

Class PushConfig

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.pubsub.model.PushConfig

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Configuration for a push delivery endpoint.

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 Google Cloud Pub/Sub 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
PushConfig()

Method Summary

Methods

Modifier and Type	Method and Description
PushConfig	clone()
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Endpoint configuration attributes.
java.lang.String	getPushEndpoint() A URL locating the endpoint to which messages should be pushed.
PushConfig	set(java.lang.String fieldName, java.lang.Object value)
PushConfig	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) Endpoint configuration attributes.
PushConfig	setPushEndpoint(java.lang.String pushEndpoint) A URL locating the endpoint to which messages should be pushed.

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

Constructor Detail

PushConfig

public PushConfig()

Method Detail

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.

Returns:

value or null for none

setAttributes

public PushConfig setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.

Parameters:

attributes - attributes or null for none

getPushEndpoint

public java.lang.String getPushEndpoint()

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".

Returns:

value or null for none

setPushEndpoint

public PushConfig setPushEndpoint(java.lang.String pushEndpoint)

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".

Parameters:

pushEndpoint - pushEndpoint or null for none

set

public PushConfig set(java.lang.String fieldName,
             java.lang.Object value)

Overrides:

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

clone

public PushConfig clone()

Overrides:

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