final case class PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = ...) extends GeneratedMessage with Message[PushConfig] 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. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The 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). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during 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 possible values for this 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.

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

Instance Constructors

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

    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. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The 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). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during 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 possible values for this 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.

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: TraversableOnce[(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. def clearAttributes: PushConfig
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  10. def companion: PushConfig.type
    Definition Classes
    PushConfig → GeneratedMessage
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PushConfig → GeneratedMessage
  14. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PushConfig → GeneratedMessage
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def mergeFrom(_input__: CodedInputStream): PushConfig
    Definition Classes
    PushConfig → Message
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val pushEndpoint: String
  21. final def serializedSize: Int
    Definition Classes
    PushConfig → GeneratedMessage
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  24. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  25. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  26. def toProtoString: String
    Definition Classes
    PushConfig → GeneratedMessage
  27. def update(ms: (Lens[PushConfig, PushConfig]) ⇒ Mutation[PushConfig]*): PushConfig
    Definition Classes
    Updatable
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withAttributes(__v: Map[String, String]): PushConfig
  32. def withPushEndpoint(__v: String): PushConfig
  33. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  34. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PushConfig → GeneratedMessage
  35. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def getAllFields: Map[FieldDescriptor, Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  3. def getField(field: FieldDescriptor): Any
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[PushConfig]

Inherited from Message[PushConfig]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped