Packages

c

com.google.pubsub.v1

PushConfig

final class PushConfig extends GeneratedMessageV3 with PushConfigOrBuilder

Configuration for a push delivery endpoint.

Protobuf type google.pubsub.v1.PushConfig

Source
PushConfig.java
Linear Supertypes
PushConfigOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PushConfig
  2. PushConfigOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def containsAttributes(key: String): Boolean

    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" }`


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: AnyRef): Boolean
    Definition Classes
    PushConfig → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  12. def getAttributesCount(): Int

    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" }`


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
  13. def getAttributesMap(): Map[String, String]

    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" }`


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  14. def getAttributesOrDefault(key: String, defaultValue: String): String

    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" }`


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  15. def getAttributesOrThrow(key: String): String

    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" }`


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  16. def getAuthenticationMethodCase(): AuthenticationMethodCase
    Definition Classes
    PushConfig → PushConfigOrBuilder
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getDefaultInstanceForType(): PushConfig
    Definition Classes
    PushConfig → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  19. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  20. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  21. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  22. def getNoWrapper(): NoWrapper

    When set, the payload to the push endpoint is not wrapped.


    When set, the payload to the push endpoint is not wrapped.

    .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

    returns

    The noWrapper.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  23. def getNoWrapperOrBuilder(): NoWrapperOrBuilder

    When set, the payload to the push endpoint is not wrapped.


    When set, the payload to the push endpoint is not wrapped.

    .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  24. def getOidcToken(): OidcToken

    If specified, Pub/Sub will generate and attach an OIDC JWT token as an
`Authorization` header in the HTTP request for every pushed message.


    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

    The oidcToken.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  25. def getOidcTokenOrBuilder(): OidcTokenOrBuilder

    If specified, Pub/Sub will generate and attach an OIDC JWT token as an
`Authorization` header in the HTTP request for every pushed message.


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  26. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  27. def getParserForType(): Parser[PushConfig]
    Definition Classes
    PushConfig → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  28. def getPubsubWrapper(): PubsubWrapper

    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).


    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;

    returns

    The pubsubWrapper.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  29. def getPubsubWrapperOrBuilder(): PubsubWrapperOrBuilder

    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).


    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;

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  30. def getPushEndpoint(): String

    A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use `https://example.com/push`.


    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

    The pushEndpoint.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  31. def getPushEndpointBytes(): ByteString

    A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use `https://example.com/push`.


    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

    The bytes for pushEndpoint.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  32. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  33. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  34. def getSerializedSize(): Int
    Definition Classes
    PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  35. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  36. def getWrapperCase(): WrapperCase
    Definition Classes
    PushConfig → PushConfigOrBuilder
  37. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  38. def hasNoWrapper(): Boolean

    When set, the payload to the push endpoint is not wrapped.


    When set, the payload to the push endpoint is not wrapped.

    .google.pubsub.v1.PushConfig.NoWrapper no_wrapper = 5;

    returns

    Whether the noWrapper field is set.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  39. def hasOidcToken(): Boolean

    If specified, Pub/Sub will generate and attach an OIDC JWT token as an
`Authorization` header in the HTTP request for every pushed message.


    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

    Whether the oidcToken field is set.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  40. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  41. def hasPubsubWrapper(): Boolean

    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).


    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;

    returns

    Whether the pubsubWrapper field is set.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override()
  42. def hashCode(): Int
    Definition Classes
    PushConfig → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  43. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
    Annotations
    @Override()
  44. def internalGetMapField(number: Int): MapField
    Attributes
    protected[v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
    Annotations
    @SuppressWarnings() @Override()
  45. final def isInitialized(): Boolean
    Definition Classes
    PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  48. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
    Annotations
    @Override()
  51. def newBuilderForType(): Builder
    Definition Classes
    PushConfig → Message → MessageLite
    Annotations
    @Override()
  52. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  53. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    PushConfig → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  57. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  58. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  59. def toBuilder(): Builder
    Definition Classes
    PushConfig → Message → MessageLite
    Annotations
    @Override()
  60. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  61. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  62. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  66. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  67. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  68. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    PushConfig → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  69. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getAttributes(): Map[String, String]

    Use #getAttributesMap() instead.

    Use #getAttributesMap() instead.

    Definition Classes
    PushConfig → PushConfigOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated

Inherited from PushConfigOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped