com.google.api.services.pubsub.model

Class PushConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pubsub.model.PushConfig

All Implemented Interfaces:

Cloneable, Map<String,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 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

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
PushConfig()

Method Summary

Modifier and Type	Method and Description
PushConfig	clone()
Map<String,String>	getAttributes() Optional.
NoWrapper	getNoWrapper() Optional.
OidcToken	getOidcToken() Optional.
PubsubWrapper	getPubsubWrapper() Optional.
String	getPushEndpoint() Optional.
PushConfig	set(String fieldName, Object value)
PushConfig	setAttributes(Map<String,String> attributes) Optional.
PushConfig	setNoWrapper(NoWrapper noWrapper) Optional.
PushConfig	setOidcToken(OidcToken oidcToken) Optional.
PushConfig	setPubsubWrapper(PubsubWrapper pubsubWrapper) Optional.
PushConfig	setPushEndpoint(String pushEndpoint) Optional.

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

PushConfig

public PushConfig()

Method Detail

getAttributes

public Map<String,String> getAttributes()

Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x -goog-version` 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. For example: `attributes { "x-goog-version": "v1" }`

Returns:

value or null for none

setAttributes

public PushConfig setAttributes(Map<String,String> attributes)

Optional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the `x -goog-version` 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. For example: `attributes { "x-goog-version": "v1" }`

Parameters:

attributes - attributes or null for none

getNoWrapper

public NoWrapper getNoWrapper()

Optional. When set, the payload to the push endpoint is not wrapped.

Returns:

value or null for none

setNoWrapper

public PushConfig setNoWrapper(NoWrapper noWrapper)

Optional. When set, the payload to the push endpoint is not wrapped.

Parameters:

noWrapper - noWrapper or null for none

getOidcToken

public OidcToken getOidcToken()

Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.

Returns:

value or null for none

setOidcToken

public PushConfig setOidcToken(OidcToken oidcToken)

Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.

Parameters:

oidcToken - oidcToken or null for none

getPubsubWrapper

public PubsubWrapper getPubsubWrapper()

Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

Returns:

value or null for none

setPubsubWrapper

public PushConfig setPubsubWrapper(PubsubWrapper pubsubWrapper)

Optional. When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

Parameters:

pubsubWrapper - pubsubWrapper or null for none

getPushEndpoint

public String getPushEndpoint()

Optional. 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(String pushEndpoint)

Optional. 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(String fieldName,
                      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