Interface PushConfigOrBuilder (1.125.6)

Version 1.125.6

• 1.134.2 (latest)
• 1.134.1
• 1.133.1
• 1.132.2
• 1.131.0
• 1.130.0
• 1.129.6
• 1.127.3
• 1.126.6
• 1.125.13
• 1.123.18
• 1.122.2
• 1.121.1
• 1.120.24
• 1.119.1
• 1.118.0
• 1.117.0
• 1.116.4
• 1.115.5

public interface PushConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

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" }

map<string, string> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributes()

public abstract Map<String,String> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
Map<String,String>

getAttributesCount()

public abstract int getAttributesCount()

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" }

map<string, string> attributes = 2;

Returns
Type	Description
int

getAttributesMap()

public abstract Map<String,String> getAttributesMap()

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" }

map<string, string> attributes = 2;

Returns
Type	Description
Map<String,String>

getAttributesOrDefault(String key, String defaultValue)

public abstract String getAttributesOrDefault(String key, String defaultValue)

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" }

map<string, string> attributes = 2;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAttributesOrThrow(String key)

public abstract String getAttributesOrThrow(String key)

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" }

map<string, string> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getAuthenticationMethodCase()

public abstract PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()

Returns
Type	Description
PushConfig.AuthenticationMethodCase

getNoWrapper()

public abstract PushConfig.NoWrapper getNoWrapper()

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

.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

Returns
Type	Description
PushConfig.NoWrapper	The noWrapper.

getNoWrapperOrBuilder()

public abstract PushConfig.NoWrapperOrBuilder getNoWrapperOrBuilder()

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

.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

Returns
Type	Description
PushConfig.NoWrapperOrBuilder

getOidcToken()

public abstract PushConfig.OidcToken getOidcToken()

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

.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3;

Returns
Type	Description
PushConfig.OidcToken	The oidcToken.

getOidcTokenOrBuilder()

public abstract PushConfig.OidcTokenOrBuilder getOidcTokenOrBuilder()

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

.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3;

Returns
Type	Description
PushConfig.OidcTokenOrBuilder

getPubsubWrapper()

public abstract PushConfig.PubsubWrapper getPubsubWrapper()

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).

.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4;

Returns
Type	Description
PushConfig.PubsubWrapper	The pubsubWrapper.

getPubsubWrapperOrBuilder()

public abstract PushConfig.PubsubWrapperOrBuilder getPubsubWrapperOrBuilder()

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).

.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4;

Returns
Type	Description
PushConfig.PubsubWrapperOrBuilder

getPushEndpoint()

public abstract String getPushEndpoint()

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

string push_endpoint = 1;

Returns
Type	Description
String	The pushEndpoint.

getPushEndpointBytes()

public abstract ByteString getPushEndpointBytes()

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

string push_endpoint = 1;

Returns
Type	Description
ByteString	The bytes for pushEndpoint.

getWrapperCase()

public abstract PushConfig.WrapperCase getWrapperCase()

Returns
Type	Description
PushConfig.WrapperCase

hasNoWrapper()

public abstract boolean hasNoWrapper()

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

.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

Returns
Type	Description
boolean	Whether the noWrapper field is set.

hasOidcToken()

public abstract boolean hasOidcToken()

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

.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3;

Returns
Type	Description
boolean	Whether the oidcToken field is set.

hasPubsubWrapper()

public abstract boolean hasPubsubWrapper()

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).

.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4;

Returns
Type	Description
boolean	Whether the pubsubWrapper field is set.