Package com.google.pubsub.v1

Class PushConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PushConfigOrBuilder, Cloneable
    Enclosing class:
    PushConfig
    public static final class PushConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>
implements PushConfigOrBuilder
     Configuration for a push delivery endpoint.
    Protobuf type google.pubsub.v1.PushConfig

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • clear

        public PushConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • getDefaultInstanceForType

        public PushConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public PushConfig build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public PushConfig buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public PushConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • setField

        public PushConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • clearField

        public PushConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • clearOneof

        public PushConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • setRepeatedField

        public PushConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • addRepeatedField

        public PushConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • mergeFrom

        public PushConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PushConfig.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • mergeFrom

        public PushConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PushConfig.Builder>
        Throws:
        IOException

      • 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;
        Specified by:
        getPushEndpoint in interface PushConfigOrBuilder
        Returns:
        The pushEndpoint.

      • getPushEndpointBytes

        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;
        Specified by:
        getPushEndpointBytes in interface PushConfigOrBuilder
        Returns:
        The bytes for pushEndpoint.

      • setPushEndpoint

        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;
        Parameters:
        value - The pushEndpoint to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setPushEndpointBytes

        public PushConfig.Builder setPushEndpointBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for pushEndpoint to set.
        Returns:
        This builder for chaining.

      • getAttributesCount

        public int getAttributesCount()
        Description copied from interface: 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;
        Specified by:
        getAttributesCount in interface PushConfigOrBuilder

      • containsAttributes

        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;
        Specified by:
        containsAttributes in interface PushConfigOrBuilder

      • 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:
 `attributes { "x-goog-version": "v1" }`
        map<string, string> attributes = 2;
        Specified by:
        getAttributesMap in interface PushConfigOrBuilder

      • getAttributesOrDefault

        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;
        Specified by:
        getAttributesOrDefault in interface PushConfigOrBuilder

      • getAttributesOrThrow

        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;
        Specified by:
        getAttributesOrThrow in interface PushConfigOrBuilder

      • removeAttributes

        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:
 `attributes { "x-goog-version": "v1" }`
        map<string, string> attributes = 2;

      • getMutableAttributes

        @Deprecated
public Map<String,​String> getMutableAttributes()
        Deprecated.
        Use alternate mutation accessors instead.

      • putAttributes

        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:
 `attributes { "x-goog-version": "v1" }`
        map<string, string> attributes = 2;

      • putAllAttributes

        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:
 `attributes { "x-goog-version": "v1" }`
        map<string, string> attributes = 2;

      • 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;
        Specified by:
        hasOidcToken in interface PushConfigOrBuilder
        Returns:
        Whether the oidcToken field is set.

      • 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;
        Specified by:
        getOidcToken in interface PushConfigOrBuilder
        Returns:
        The oidcToken.

      • setOidcToken

        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

        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;

      • mergeOidcToken

        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;

      • 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;

      • 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;
        Specified by:
        getOidcTokenOrBuilder in interface PushConfigOrBuilder

      • hasPubsubWrapper

        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;
        Specified by:
        hasPubsubWrapper in interface PushConfigOrBuilder
        Returns:
        Whether the pubsubWrapper field is set.

      • getPubsubWrapper

        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;
        Specified by:
        getPubsubWrapper in interface PushConfigOrBuilder
        Returns:
        The pubsubWrapper.

      • setPubsubWrapper

        public PushConfig.Builder setPubsubWrapper​(PushConfig.PubsubWrapper value)
         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;

      • setPubsubWrapper

        public PushConfig.Builder setPubsubWrapper​(PushConfig.PubsubWrapper.Builder builderForValue)
         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;

      • mergePubsubWrapper

        public PushConfig.Builder mergePubsubWrapper​(PushConfig.PubsubWrapper value)
         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;

      • clearPubsubWrapper

        public PushConfig.Builder clearPubsubWrapper()
         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;

      • getPubsubWrapperBuilder

        public PushConfig.PubsubWrapper.Builder getPubsubWrapperBuilder()
         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

        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;
        Specified by:
        getPubsubWrapperOrBuilder in interface PushConfigOrBuilder

      • hasNoWrapper

        public boolean hasNoWrapper()
         When set, the payload to the push endpoint is not wrapped.
        .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
        Specified by:
        hasNoWrapper in interface PushConfigOrBuilder
        Returns:
        Whether the noWrapper field is set.

      • getNoWrapper

        public PushConfig.NoWrapper getNoWrapper()
         When set, the payload to the push endpoint is not wrapped.
        .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;
        Specified by:
        getNoWrapper in interface PushConfigOrBuilder
        Returns:
        The noWrapper.

      • setNoWrapper

        public PushConfig.Builder setNoWrapper​(PushConfig.NoWrapper value)
         When set, the payload to the push endpoint is not wrapped.
        .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

      • mergeNoWrapper

        public PushConfig.Builder mergeNoWrapper​(PushConfig.NoWrapper value)
         When set, the payload to the push endpoint is not wrapped.
        .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

      • clearNoWrapper

        public PushConfig.Builder clearNoWrapper()
         When set, the payload to the push endpoint is not wrapped.
        .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

      • getNoWrapperBuilder

        public PushConfig.NoWrapper.Builder getNoWrapperBuilder()
         When set, the payload to the push endpoint is not wrapped.
        .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

      • setUnknownFields

        public final PushConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>

      • mergeUnknownFields

        public final PushConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PushConfig.Builder>