final case class PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = _root_.scala.collection.immutable.Map.empty, authenticationMethod: AuthenticationMethod = com.google.pubsub.v1.pubsub.PushConfig.AuthenticationMethod.Empty, wrapper: Wrapper = com.google.pubsub.v1.pubsub.PushConfig.Wrapper.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[PushConfig] with Product with Serializable
Configuration for a push delivery endpoint.
- pushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use
https://example.com/push
.- attributes
Optional. 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 theCreateSubscription
call, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig
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 thex-goog-version
attribute are: *v1beta1
: uses the push format defined in the v1beta1 Pub/Sub API. *v1
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. For example:attributes { "x-goog-version": "v1" }
- Annotations
- @SerialVersionUID()
- Source
- PushConfig.scala
- Alphabetic
- By Inheritance
- PushConfig
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PushConfig(pushEndpoint: String = "", attributes: Map[String, String] = _root_.scala.collection.immutable.Map.empty, authenticationMethod: AuthenticationMethod = com.google.pubsub.v1.pubsub.PushConfig.AuthenticationMethod.Empty, wrapper: Wrapper = com.google.pubsub.v1.pubsub.PushConfig.Wrapper.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- pushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use
https://example.com/push
.- attributes
Optional. 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 theCreateSubscription
call, it will default to the version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig
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 thex-goog-version
attribute are: *v1beta1
: uses the push format defined in the v1beta1 Pub/Sub API. *v1
orv1beta2
: uses the push format defined in the v1 Pub/Sub API. For example:attributes { "x-goog-version": "v1" }
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllAttributes(__vs: Iterable[(String, String)]): PushConfig
- def addAttributes(__vs: (String, String)*): PushConfig
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val attributes: Map[String, String]
- val authenticationMethod: AuthenticationMethod
- def clearAttributes: PushConfig
- def clearAuthenticationMethod: PushConfig
- def clearWrapper: PushConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: PushConfig.type
- Definition Classes
- PushConfig → GeneratedMessage
- def discardUnknownFields: PushConfig
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- PushConfig → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- PushConfig → GeneratedMessage
- def getNoWrapper: NoWrapper
- def getOidcToken: OidcToken
- def getPubsubWrapper: PubsubWrapper
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val pushEndpoint: String
- def serializedSize: Int
- Definition Classes
- PushConfig → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- PushConfig → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[PushConfig, PushConfig]) => Mutation[PushConfig]*): PushConfig
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAttributes(__v: Map[String, String]): PushConfig
- def withAuthenticationMethod(__v: AuthenticationMethod): PushConfig
- def withNoWrapper(__v: NoWrapper): PushConfig
- def withOidcToken(__v: OidcToken): PushConfig
- def withPubsubWrapper(__v: PubsubWrapper): PushConfig
- def withPushEndpoint(__v: String): PushConfig
- def withUnknownFields(__v: UnknownFieldSet): PushConfig
- def withWrapper(__v: Wrapper): PushConfig
- val wrapper: Wrapper
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- PushConfig → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage