final case class PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = ..., authenticationMethod: AuthenticationMethod = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PushConfig] with Product with Serializable

Configuration for a push delivery endpoint.

pushEndpoint

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

attributes

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>

Annotations
@SerialVersionUID()
Source
PushConfig.scala
Linear Supertypes
Product, Equals, Updatable[PushConfig], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PushConfig
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = ..., authenticationMethod: AuthenticationMethod = ..., unknownFields: UnknownFieldSet = ...)

    pushEndpoint

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

    attributes

    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>

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. def addAllAttributes(__vs: Iterable[(String, String)]): PushConfig
  5. def addAttributes(__vs: (String, String)*): PushConfig
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val attributes: Map[String, String]
  8. val authenticationMethod: AuthenticationMethod
  9. def clearAttributes: PushConfig
  10. def clearAuthenticationMethod: PushConfig
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. def companion: PushConfig.type
    Definition Classes
    PushConfig → GeneratedMessage
  13. def discardUnknownFields: PushConfig
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PushConfig → GeneratedMessage
  17. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PushConfig → GeneratedMessage
  18. def getOidcToken: OidcToken
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val pushEndpoint: String
  24. def serializedSize: Int
    Definition Classes
    PushConfig → GeneratedMessage
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  27. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  28. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  29. def toProtoString: String
    Definition Classes
    PushConfig → GeneratedMessage
  30. val unknownFields: UnknownFieldSet
  31. def update(ms: (Lens[PushConfig, PushConfig]) ⇒ Mutation[PushConfig]*): PushConfig
    Definition Classes
    Updatable
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withAttributes(__v: Map[String, String]): PushConfig
  36. def withAuthenticationMethod(__v: AuthenticationMethod): PushConfig
  37. def withOidcToken(__v: OidcToken): PushConfig
  38. def withPushEndpoint(__v: String): PushConfig
  39. def withUnknownFields(__v: UnknownFieldSet): PushConfig
  40. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  41. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PushConfig → GeneratedMessage
  42. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Product

Inherited from Equals

Inherited from Updatable[PushConfig]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped