public interface PushConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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.v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
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 | |
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 | |
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. |
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. |