public interface PushConfigOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
containsAttributes(String key)
public abstract boolean containsAttributes(String key)
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
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()
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getAttributesMap()
public abstract Map<String,String> getAttributesMap()
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAttributesOrDefault(String key, String defaultValue)
public abstract String getAttributesOrDefault(String key, String defaultValue)
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getAttributesOrThrow(String key)
public abstract String getAttributesOrThrow(String key)
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
orv1beta2
: uses the push format defined in the v1 Pub/Sub API.For example:
attributes { "x-goog-version": "v1" }
map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
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()
Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PushConfig.NoWrapper | The noWrapper. |
getNoWrapperOrBuilder()
public abstract PushConfig.NoWrapperOrBuilder getNoWrapperOrBuilder()
Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PushConfig.NoWrapperOrBuilder |
getOidcToken()
public abstract PushConfig.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.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PushConfig.OidcToken | The oidcToken. |
getOidcTokenOrBuilder()
public abstract PushConfig.OidcTokenOrBuilder getOidcTokenOrBuilder()
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.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PushConfig.OidcTokenOrBuilder |
getPubsubWrapper()
public abstract PushConfig.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).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PushConfig.PubsubWrapper | The pubsubWrapper. |
getPubsubWrapperOrBuilder()
public abstract PushConfig.PubsubWrapperOrBuilder getPubsubWrapperOrBuilder()
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).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
PushConfig.PubsubWrapperOrBuilder |
getPushEndpoint()
public abstract 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
.
string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The pushEndpoint. |
getPushEndpointBytes()
public abstract ByteString getPushEndpointBytes()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pushEndpoint. |
getWrapperCase()
public abstract PushConfig.WrapperCase getWrapperCase()
Returns | |
---|---|
Type | Description |
PushConfig.WrapperCase |
hasNoWrapper()
public abstract boolean hasNoWrapper()
Optional. When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the noWrapper field is set. |
hasOidcToken()
public abstract boolean hasOidcToken()
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.
.google.pubsub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the oidcToken field is set. |
hasPubsubWrapper()
public abstract boolean hasPubsubWrapper()
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).
.google.pubsub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean | Whether the pubsubWrapper field is set. |