public final class PushConfig extends com.google.protobuf.GeneratedMessageV3 implements PushConfigOrBuilder
Configuration for a push delivery endpoint.Protobuf type
google.pubsub.v1.PushConfig
Modifier and Type | Class and Description |
---|---|
static class |
PushConfig.AuthenticationMethodCase |
static class |
PushConfig.Builder
Configuration for a push delivery endpoint.
|
static class |
PushConfig.NoWrapper
Sets the `data` field as the HTTP body for delivery.
|
static interface |
PushConfig.NoWrapperOrBuilder |
static class |
PushConfig.OidcToken
Contains information needed for generating an
[OpenID Connect
token](https://developers.google.com/identity/protocols/OpenIDConnect).
|
static interface |
PushConfig.OidcTokenOrBuilder |
static class |
PushConfig.PubsubWrapper
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).
|
static interface |
PushConfig.PubsubWrapperOrBuilder |
static class |
PushConfig.WrapperCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
ATTRIBUTES_FIELD_NUMBER |
static int |
NO_WRAPPER_FIELD_NUMBER |
static int |
OIDC_TOKEN_FIELD_NUMBER |
static int |
PUBSUB_WRAPPER_FIELD_NUMBER |
static int |
PUSH_ENDPOINT_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
containsAttributes(String key)
Endpoint configuration attributes that can be used to control different
aspects of the message delivery.
|
boolean |
equals(Object obj) |
Map<String,String> |
getAttributes()
Deprecated.
|
int |
getAttributesCount()
Endpoint configuration attributes that can be used to control different
aspects of the message delivery.
|
Map<String,String> |
getAttributesMap()
Endpoint configuration attributes that can be used to control different
aspects of the message delivery.
|
String |
getAttributesOrDefault(String key,
String defaultValue)
Endpoint configuration attributes that can be used to control different
aspects of the message delivery.
|
String |
getAttributesOrThrow(String key)
Endpoint configuration attributes that can be used to control different
aspects of the message delivery.
|
PushConfig.AuthenticationMethodCase |
getAuthenticationMethodCase() |
static PushConfig |
getDefaultInstance() |
PushConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
PushConfig.NoWrapper |
getNoWrapper()
When set, the payload to the push endpoint is not wrapped.
|
PushConfig.NoWrapperOrBuilder |
getNoWrapperOrBuilder()
When set, the payload to the push endpoint is not wrapped.
|
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.
|
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.
|
com.google.protobuf.Parser<PushConfig> |
getParserForType() |
PushConfig.PubsubWrapper |
getPubsubWrapper()
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).
|
PushConfig.PubsubWrapperOrBuilder |
getPubsubWrapperOrBuilder()
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).
|
String |
getPushEndpoint()
A URL locating the endpoint to which messages should be pushed.
|
com.google.protobuf.ByteString |
getPushEndpointBytes()
A URL locating the endpoint to which messages should be pushed.
|
int |
getSerializedSize() |
PushConfig.WrapperCase |
getWrapperCase() |
int |
hashCode() |
boolean |
hasNoWrapper()
When set, the payload to the push endpoint is not wrapped.
|
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.
|
boolean |
hasPubsubWrapper()
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).
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static PushConfig.Builder |
newBuilder() |
static PushConfig.Builder |
newBuilder(PushConfig prototype) |
PushConfig.Builder |
newBuilderForType() |
protected PushConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static PushConfig |
parseDelimitedFrom(InputStream input) |
static PushConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PushConfig |
parseFrom(byte[] data) |
static PushConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PushConfig |
parseFrom(ByteBuffer data) |
static PushConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PushConfig |
parseFrom(com.google.protobuf.ByteString data) |
static PushConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PushConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static PushConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PushConfig |
parseFrom(InputStream input) |
static PushConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<PushConfig> |
parser() |
PushConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int PUSH_ENDPOINT_FIELD_NUMBER
public static final int ATTRIBUTES_FIELD_NUMBER
public static final int OIDC_TOKEN_FIELD_NUMBER
public static final int PUBSUB_WRAPPER_FIELD_NUMBER
public static final int NO_WRAPPER_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public PushConfig.AuthenticationMethodCase getAuthenticationMethodCase()
getAuthenticationMethodCase
in interface PushConfigOrBuilder
public PushConfig.WrapperCase getWrapperCase()
getWrapperCase
in interface PushConfigOrBuilder
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;
getPushEndpoint
in interface PushConfigOrBuilder
public com.google.protobuf.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;
getPushEndpointBytes
in interface PushConfigOrBuilder
public int getAttributesCount()
PushConfigOrBuilder
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;
getAttributesCount
in interface PushConfigOrBuilder
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: `attributes { "x-goog-version": "v1" }`
map<string, string> attributes = 2;
containsAttributes
in interface PushConfigOrBuilder
@Deprecated public Map<String,String> getAttributes()
getAttributesMap()
instead.getAttributes
in interface PushConfigOrBuilder
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: `attributes { "x-goog-version": "v1" }`
map<string, string> attributes = 2;
getAttributesMap
in interface PushConfigOrBuilder
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: `attributes { "x-goog-version": "v1" }`
map<string, string> attributes = 2;
getAttributesOrDefault
in interface PushConfigOrBuilder
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: `attributes { "x-goog-version": "v1" }`
map<string, string> attributes = 2;
getAttributesOrThrow
in interface PushConfigOrBuilder
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;
hasOidcToken
in interface PushConfigOrBuilder
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;
getOidcToken
in interface PushConfigOrBuilder
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;
getOidcTokenOrBuilder
in interface PushConfigOrBuilder
public boolean hasPubsubWrapper()
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;
hasPubsubWrapper
in interface PushConfigOrBuilder
public PushConfig.PubsubWrapper getPubsubWrapper()
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;
getPubsubWrapper
in interface PushConfigOrBuilder
public PushConfig.PubsubWrapperOrBuilder getPubsubWrapperOrBuilder()
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;
getPubsubWrapperOrBuilder
in interface PushConfigOrBuilder
public boolean hasNoWrapper()
When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
hasNoWrapper
in interface PushConfigOrBuilder
public PushConfig.NoWrapper getNoWrapper()
When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
getNoWrapper
in interface PushConfigOrBuilder
public PushConfig.NoWrapperOrBuilder getNoWrapperOrBuilder()
When set, the payload to the push endpoint is not wrapped.
.google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
getNoWrapperOrBuilder
in interface PushConfigOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static PushConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static PushConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static PushConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static PushConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static PushConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static PushConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static PushConfig parseFrom(InputStream input) throws IOException
IOException
public static PushConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static PushConfig parseDelimitedFrom(InputStream input) throws IOException
IOException
public static PushConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static PushConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static PushConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public PushConfig.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static PushConfig.Builder newBuilder()
public static PushConfig.Builder newBuilder(PushConfig prototype)
public PushConfig.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected PushConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static PushConfig getDefaultInstance()
public static com.google.protobuf.Parser<PushConfig> parser()
public com.google.protobuf.Parser<PushConfig> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public PushConfig getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.