com.google.cloud.pubsub

Class PushConfig.Builder

java.lang.Object

com.google.cloud.pubsub.PushConfig.Builder

Enclosing class:

PushConfig

public static final class PushConfig.Builder
extends Object

Builder for PushConfig objects.

Method Summary

Methods

Modifier and Type	Method and Description
PushConfig.Builder	addAttribute(String name, String value) Adds an API-supported attribute that can be used to control different aspects of the message delivery.
PushConfig.Builder	attributes(Map<String,String> attributes) Sets the API-supported attributes that can be used to control different aspects of the message delivery.
PushConfig	build() Creates a PushConfig object.
PushConfig.Builder	clearAttributes() Clears all API-supported attributes.
PushConfig.Builder	endpoint(String endpoint) Sets the URL locating the endpoint to which messages should be pushed.
PushConfig.Builder	removeAttribute(String name) Removes an API-supported attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

endpoint

public PushConfig.Builder endpoint(String endpoint)

Sets the URL locating the endpoint to which messages should be pushed. For example, an endpoint might use https://example.com/push.

addAttribute

public PushConfig.Builder addAttribute(String name,
                              String value)

Adds an API-supported attribute that can be used to control different aspects of the message delivery.

The currently supported attribute is x-goog-version, which can be used to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. The endpoint version is based on the version of the Pub/Sub API. 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

If the x-goog-version attribute is not present when a subscription is created (see PubSub.create(SubscriptionInfo) and PubSub.createAsync(SubscriptionInfo)), it will default to v1. If it is not present when modifying the push config (see PubSub.replacePushConfig(String, PushConfig) and PubSub.replacePushConfigAsync(String, PushConfig)), its value will not be changed.

See Also:

Message Format

attributes

public PushConfig.Builder attributes(Map<String,String> attributes)

Sets the API-supported attributes that can be used to control different aspects of the message delivery.

The currently supported attribute is x-goog-version, which can be used to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. The endpoint version is based on the version of the Pub/Sub API. 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

If the x-goog-version attribute is not present when a subscription is created (see PubSub.create(SubscriptionInfo) and PubSub.createAsync(SubscriptionInfo)), it will default to v1. If it is not present when modifying the push config (see PubSub.replacePushConfig(String, PushConfig) and PubSub.replacePushConfigAsync(String, PushConfig)), its value will not be changed.

See Also:

Message Format

removeAttribute

public PushConfig.Builder removeAttribute(String name)

Removes an API-supported attribute.

clearAttributes

public PushConfig.Builder clearAttributes()

Clears all API-supported attributes.

build

public PushConfig build()

Creates a PushConfig object.