Class PushConfig.Builder (1.119.1)

public static final class PushConfig.Builder extends GeneratedMessageV3.Builder<PushConfig.Builder> implements PushConfigOrBuilder

Configuration for a push delivery endpoint.

Protobuf type google.pubsub.v1.PushConfig

Implements

PushConfigOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PushConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PushConfig.Builder
Overrides

build()

public PushConfig build()
Returns
TypeDescription
PushConfig

buildPartial()

public PushConfig buildPartial()
Returns
TypeDescription
PushConfig

clear()

public PushConfig.Builder clear()
Returns
TypeDescription
PushConfig.Builder
Overrides

clearAttributes()

public PushConfig.Builder clearAttributes()
Returns
TypeDescription
PushConfig.Builder

clearAuthenticationMethod()

public PushConfig.Builder clearAuthenticationMethod()
Returns
TypeDescription
PushConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public PushConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PushConfig.Builder
Overrides

clearOidcToken()

public PushConfig.Builder clearOidcToken()

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
TypeDescription
PushConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PushConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PushConfig.Builder
Overrides

clearPushEndpoint()

public PushConfig.Builder clearPushEndpoint()

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
TypeDescription
PushConfig.Builder

This builder for chaining.

clone()

public PushConfig.Builder clone()
Returns
TypeDescription
PushConfig.Builder
Overrides

containsAttributes(String key)

public 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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAttributes()

public Map<String,String> getAttributes()

Use #getAttributesMap() instead.

Returns
TypeDescription
Map<String,String>

getAttributesCount()

public 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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Returns
TypeDescription
int

getAttributesMap()

public 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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Returns
TypeDescription
Map<String,String>

getAttributesOrDefault(String key, String defaultValue)

public 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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAttributesOrThrow(String key)

public 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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getAuthenticationMethodCase()

public PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()
Returns
TypeDescription
PushConfig.AuthenticationMethodCase

getDefaultInstanceForType()

public PushConfig getDefaultInstanceForType()
Returns
TypeDescription
PushConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableAttributes()

public Map<String,String> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getOidcToken()

public 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
TypeDescription
PushConfig.OidcToken

The oidcToken.

getOidcTokenBuilder()

public PushConfig.OidcToken.Builder getOidcTokenBuilder()

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
TypeDescription
PushConfig.OidcToken.Builder

getOidcTokenOrBuilder()

public 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
TypeDescription
PushConfig.OidcTokenOrBuilder

getPushEndpoint()

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

The pushEndpoint.

getPushEndpointBytes()

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

The bytes for pushEndpoint.

hasOidcToken()

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

Whether the oidcToken field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PushConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PushConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PushConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PushConfig.Builder
Overrides

mergeFrom(PushConfig other)

public PushConfig.Builder mergeFrom(PushConfig other)
Parameter
NameDescription
otherPushConfig
Returns
TypeDescription
PushConfig.Builder

mergeOidcToken(PushConfig.OidcToken value)

public PushConfig.Builder mergeOidcToken(PushConfig.OidcToken value)

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;

Parameter
NameDescription
valuePushConfig.OidcToken
Returns
TypeDescription
PushConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PushConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PushConfig.Builder
Overrides

putAllAttributes(Map<String,String> values)

public PushConfig.Builder putAllAttributes(Map<String,String> values)

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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
PushConfig.Builder

putAttributes(String key, String value)

public PushConfig.Builder putAttributes(String key, String value)

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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
PushConfig.Builder

removeAttributes(String key)

public PushConfig.Builder removeAttributes(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: <pre><code>attributes { "x-goog-version": "v1" } </code></pre>

map<string, string> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
PushConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PushConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PushConfig.Builder
Overrides

setOidcToken(PushConfig.OidcToken value)

public PushConfig.Builder setOidcToken(PushConfig.OidcToken value)

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;

Parameter
NameDescription
valuePushConfig.OidcToken
Returns
TypeDescription
PushConfig.Builder

setOidcToken(PushConfig.OidcToken.Builder builderForValue)

public PushConfig.Builder setOidcToken(PushConfig.OidcToken.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuePushConfig.OidcToken.Builder
Returns
TypeDescription
PushConfig.Builder

setPushEndpoint(String value)

public PushConfig.Builder setPushEndpoint(String value)

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;

Parameter
NameDescription
valueString

The pushEndpoint to set.

Returns
TypeDescription
PushConfig.Builder

This builder for chaining.

setPushEndpointBytes(ByteString value)

public PushConfig.Builder setPushEndpointBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for pushEndpoint to set.

Returns
TypeDescription
PushConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PushConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PushConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PushConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PushConfig.Builder
Overrides