Package com.google.pubsub.v1
Interface PushConfigOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
PushConfig
,PushConfig.Builder
public interface PushConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsAttributes
(String key) Endpoint configuration attributes that can be used to control different aspects of the message delivery.Deprecated.int
Endpoint configuration attributes that can be used to control different aspects of the message delivery.Endpoint configuration attributes that can be used to control different aspects of the message delivery.getAttributesOrDefault
(String key, String defaultValue) Endpoint configuration attributes that can be used to control different aspects of the message delivery.Endpoint configuration attributes that can be used to control different aspects of the message delivery.When set, the payload to the push endpoint is not wrapped.When set, the payload to the push endpoint is not wrapped.If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.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).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).A URL locating the endpoint to which messages should be pushed.com.google.protobuf.ByteString
A URL locating the endpoint to which messages should be pushed.boolean
When set, the payload to the push endpoint is not wrapped.boolean
If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.boolean
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).Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getPushEndpoint
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:
- The pushEndpoint.
-
getPushEndpointBytes
com.google.protobuf.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:
- The bytes for pushEndpoint.
-
getAttributesCount
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;
-
containsAttributes
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;
-
getAttributes
Deprecated.UsegetAttributesMap()
instead. -
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;
-
getAttributesOrDefault
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;
-
getAttributesOrThrow
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;
-
hasOidcToken
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:
- Whether the oidcToken field is set.
-
getOidcToken
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:
- The oidcToken.
-
getOidcTokenOrBuilder
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;
-
hasPubsubWrapper
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:
- Whether the pubsubWrapper field is set.
-
getPubsubWrapper
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:
- The pubsubWrapper.
-
getPubsubWrapperOrBuilder
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;
-
hasNoWrapper
boolean hasNoWrapper()When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
- Returns:
- Whether the noWrapper field is set.
-
getNoWrapper
PushConfig.NoWrapper getNoWrapper()When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
- Returns:
- The noWrapper.
-
getNoWrapperOrBuilder
PushConfig.NoWrapperOrBuilder getNoWrapperOrBuilder()When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
-
getAuthenticationMethodCase
PushConfig.AuthenticationMethodCase getAuthenticationMethodCase() -
getWrapperCase
PushConfig.WrapperCase getWrapperCase()
-