com.google.cloud.pubsub

Class PushConfig

java.lang.Object

com.google.cloud.pubsub.PushConfig

All Implemented Interfaces:

Serializable

public final class PushConfig
extends Object
implements Serializable

Google Cloud Pub/Sub configuration for a push subscription.

In a push subscription, the Pub/Sub server sends a request to the subscriber application. A PushConfig object can be used to configure the application endpoint. The subscriber's HTTP response serves as an implicit acknowledgement: a success response indicates that the message has been succesfully processed and the Pub/Sub system can delete it from the subscription; a non-success response indicates that the Pub/Sub server should resend it (implicit "nack").

See Also:

Subscriber Guide, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushConfig.Builder Builder for PushConfig objects.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	attributes() Returns the API-supported attributes that can be used to control different aspects of the message delivery.
static PushConfig.Builder	builder(String endpoint) Creates a builder for PushConfig objects given the push endpoint.
static PushConfig.Builder	builder(String endpoint, Map<String,String> attributes) Creates a builder for PushConfig objects given the push endpoint and the API-supported attributes that can be used to control different aspects of the message delivery.
String	endpoint() Returns the URL locating the endpoint to which messages should be pushed.
boolean	equals(Object obj)
int	hashCode()
static PushConfig	of(String endpoint) Creates a PushConfig object given the push endpoint.
static PushConfig	of(String endpoint, Map<String,String> attributes) Creates a PushConfig object given the push endpoint and the API-supported attributes that can be used to control different aspects of the message delivery.
PushConfig.Builder	toBuilder() Returns a builder for the PushConfig object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

endpoint

public String endpoint()

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

attributes

public Map<String,String> attributes()

Returns 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public PushConfig.Builder toBuilder()

Returns a builder for the PushConfig object.

of

public static PushConfig of(String endpoint)

Creates a PushConfig object given the push endpoint.

Parameters:

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

of

public static PushConfig of(String endpoint,
            Map<String,String> attributes)

Creates a PushConfig object given the push endpoint and the API-supported attributes that can be used to control different aspects of the message delivery.

Parameters:

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

attributes - API supported attributes used to control message delivery. See PushConfig.Builder.attributes(Map) for more details.

builder

public static PushConfig.Builder builder(String endpoint)

Creates a builder for PushConfig objects given the push endpoint.

Parameters:

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

builder

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

Creates a builder for PushConfig objects given the push endpoint and the API-supported attributes that can be used to control different aspects of the message delivery.

Parameters:

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

attributes - API supported attributes used to control message delivery. See PushConfig.Builder.attributes(Map) for more details.