Class/Object

com.google.pubsub.v1.pubsub

PushConfig

Related Docs: object PushConfig | package pubsub

Permalink

final case class PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = ..., authenticationMethod: AuthenticationMethod = ...) 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 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()
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] = ..., authenticationMethod: AuthenticationMethod = ...)

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def addAllAttributes(__vs: Iterable[(String, String)]): PushConfig

    Permalink

  5. def addAttributes(__vs: (String, String)*): PushConfig

    Permalink

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. val attributes: Map[String, String]

    Permalink

    Endpoint configuration attributes that can be used to control different aspects of the message delivery.

    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>

  8. val authenticationMethod: AuthenticationMethod

    Permalink

  9. def clearAttributes: PushConfig

    Permalink

  10. def clearAuthenticationMethod: PushConfig

    Permalink

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def companion: PushConfig.type

    Permalink
    Definition Classes
    PushConfig → GeneratedMessage

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def getField(__field: FieldDescriptor): PValue

    Permalink
    Definition Classes
    PushConfig → GeneratedMessage

  17. def getFieldByNumber(__fieldNumber: Int): Any

    Permalink
    Definition Classes
    PushConfig → GeneratedMessage

  18. def getOidcToken: OidcToken

    Permalink

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. def mergeFrom(_input__: CodedInputStream): PushConfig

    Permalink
    Definition Classes
    PushConfig → Message

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. val pushEndpoint: String

    Permalink

    A URL locating the endpoint to which messages should be pushed.

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

  25. final def serializedSize: Int

    Permalink
    Definition Classes
    PushConfig → GeneratedMessage

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. def toByteArray: Array[Byte]

    Permalink
    Definition Classes
    GeneratedMessage

  28. def toByteString: ByteString

    Permalink
    Definition Classes
    GeneratedMessage

  29. def toPMessage: PMessage

    Permalink
    Definition Classes
    GeneratedMessage

  30. def toProtoString: String

    Permalink
    Definition Classes
    PushConfig → GeneratedMessage

  31. def update(ms: (Lens[PushConfig, PushConfig]) ⇒ Mutation[PushConfig]*): PushConfig

    Permalink
    Definition Classes
    Updatable

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def withAttributes(__v: Map[String, String]): PushConfig

    Permalink

  36. def withAuthenticationMethod(__v: AuthenticationMethod): PushConfig

    Permalink

  37. def withOidcToken(__v: OidcToken): PushConfig

    Permalink

  38. def withPushEndpoint(__v: String): PushConfig

    Permalink

  39. def writeDelimitedTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

  40. def writeTo(_output__: CodedOutputStream): Unit

    Permalink
    Definition Classes
    PushConfig → GeneratedMessage

  41. def writeTo(output: OutputStream): Unit

    Permalink
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def getAllFields: Map[FieldDescriptor, Any]

    Permalink
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  2. def getField(field: FieldDescriptor): Any

    Permalink
    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