public final class PushConfig extends GeneratedMessageV3 implements PushConfigOrBuilder
Configuration for a push delivery endpoint.
Protobuf type google.pubsub.v1.PushConfig
Static Fields
ATTRIBUTES_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
OIDC_TOKEN_FIELD_NUMBER
public static final int OIDC_TOKEN_FIELD_NUMBER
Field Value
PUSH_ENDPOINT_FIELD_NUMBER
public static final int PUSH_ENDPOINT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PushConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PushConfig.Builder newBuilder()
Returns
newBuilder(PushConfig prototype)
public static PushConfig.Builder newBuilder(PushConfig prototype)
Parameter
Returns
public static PushConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PushConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PushConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PushConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PushConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PushConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PushConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PushConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PushConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PushConfig> parser()
Returns
Methods
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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
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;
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;
getParserForType()
public Parser<PushConfig> getParserForType()
Returns
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PushConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PushConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PushConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
