public final class PushConfig extends GeneratedMessageV3 implements PushConfigOrBuilder
Configuration for a push delivery endpoint.
Protobuf type google.pubsub.v1.PushConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PushConfig.Builder newBuilder()
newBuilder(PushConfig prototype)
public static PushConfig.Builder newBuilder(PushConfig prototype)
public static PushConfig parseDelimitedFrom(InputStream input)
public static PushConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PushConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PushConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(CodedInputStream input)
public static PushConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(InputStream input)
public static PushConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PushConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PushConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PushConfig> parser()
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:
map<string, string> attributes = 2;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAttributes()
public Map<String,String> getAttributes()
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:
map<string, string> attributes = 2;
| Returns |
|---|
| Type | Description |
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:
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:
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:
map<string, string> attributes = 2;
| Parameter |
|---|
| Name | Description |
key | String
|
getAuthenticationMethodCase()
public PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()
getDefaultInstanceForType()
public PushConfig getDefaultInstanceForType()
getNoWrapper()
public PushConfig.NoWrapper getNoWrapper()
When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
getNoWrapperOrBuilder()
public PushConfig.NoWrapperOrBuilder getNoWrapperOrBuilder()
When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
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()
Overrides
getPubsubWrapper()
public PushConfig.PubsubWrapper getPubsubWrapper()
getPubsubWrapperOrBuilder()
public PushConfig.PubsubWrapperOrBuilder getPubsubWrapperOrBuilder()
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 |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pushEndpoint.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getWrapperCase()
public PushConfig.WrapperCase getWrapperCase()
hasNoWrapper()
public boolean hasNoWrapper()
When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the noWrapper field is set.
|
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 |
|---|
| Type | Description |
boolean | Whether the oidcToken field is set.
|
hasPubsubWrapper()
public boolean hasPubsubWrapper()
| Returns |
|---|
| Type | Description |
boolean | Whether the pubsubWrapper field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PushConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PushConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PushConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
