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
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PushConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public PushConfig build()
Returns
buildPartial()
public PushConfig buildPartial()
Returns
clear()
public PushConfig.Builder clear()
Returns
Overrides
clearAttributes()
public PushConfig.Builder clearAttributes()
Returns
clearAuthenticationMethod()
public PushConfig.Builder clearAuthenticationMethod()
Returns
clearField(Descriptors.FieldDescriptor field)
public PushConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public PushConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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;
clone()
public PushConfig.Builder clone()
Returns
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;
getAttributes()
public Map<String,String> getAttributes()
Returns
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;
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;
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;
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;
getAuthenticationMethodCase()
public PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()
Returns
getDefaultInstanceForType()
public PushConfig getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMutableAttributes()
public Map<String,String> getMutableAttributes()
Use alternate mutation accessors instead.
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;
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;
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;
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the oidcToken field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
public PushConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public PushConfig.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeFrom(PushConfig other)
public PushConfig.Builder mergeFrom(PushConfig other)
Parameter
Returns
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PushConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
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;
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;
setField(Descriptors.FieldDescriptor field, Object value)
public PushConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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;
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;
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;
| Name | Description |
| value | String
The pushEndpoint to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for pushEndpoint to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PushConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PushConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
