Class PushConfig (1.133.0)

public final class PushConfig extends GeneratedMessageV3 implements PushConfigOrBuilder

Configuration for a push delivery endpoint.

Protobuf type google.pubsub.v1.PushConfig

Implements

PushConfigOrBuilder

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

NO_WRAPPER_FIELD_NUMBER

public static final int NO_WRAPPER_FIELD_NUMBER
Field Value
Type Description
int

OIDC_TOKEN_FIELD_NUMBER

public static final int OIDC_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PUBSUB_WRAPPER_FIELD_NUMBER

public static final int PUBSUB_WRAPPER_FIELD_NUMBER
Field Value
Type Description
int

PUSH_ENDPOINT_FIELD_NUMBER

public static final int PUSH_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PushConfig getDefaultInstance()
Returns
Type Description
PushConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PushConfig.Builder newBuilder()
Returns
Type Description
PushConfig.Builder

newBuilder(PushConfig prototype)

public static PushConfig.Builder newBuilder(PushConfig prototype)
Parameter
Name Description
prototype PushConfig
Returns
Type Description
PushConfig.Builder

parseDelimitedFrom(InputStream input)

public static PushConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PushConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PushConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PushConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PushConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PushConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PushConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PushConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PushConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PushConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PushConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PushConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PushConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PushConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PushConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PushConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PushConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PushConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PushConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PushConfig> parser()
Returns
Type Description
Parser<PushConfig>

Methods

containsAttributes(String key)

public 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 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttributes() (deprecated)

public Map<String,String> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,String>

getAttributesCount()

public 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 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAttributesMap()

public 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 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAttributesOrDefault(String key, String defaultValue)

public 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 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 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAttributesOrThrow(String key)

public 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 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getAuthenticationMethodCase()

public PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()
Returns
Type Description
PushConfig.AuthenticationMethodCase

getDefaultInstanceForType()

public PushConfig getDefaultInstanceForType()
Returns
Type Description
PushConfig

getNoWrapper()

public 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 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 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 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

getParserForType()

public Parser<PushConfig> getParserForType()
Returns
Type Description
Parser<PushConfig>
Overrides

getPubsubWrapper()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWrapperCase()

public PushConfig.WrapperCase getWrapperCase()
Returns
Type Description
PushConfig.WrapperCase

hasNoWrapper()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PushConfig.Builder newBuilderForType()
Returns
Type Description
PushConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PushConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PushConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PushConfig.Builder toBuilder()
Returns
Type Description
PushConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException