Packages

final case class AvroConfig(writeMetadata: Boolean = false, useTopicSchema: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AvroConfig] with Product with Serializable

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

writeMetadata

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

useTopicSchema

Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

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

Instance Constructors

  1. new AvroConfig(writeMetadata: Boolean = false, useTopicSchema: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    writeMetadata

    Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key as additional fields in the output. The subscription name, message_id, and publish_time fields are put in their own fields while all other message properties other than data (for example, an ordering_key, if present) are added as entries in the attributes map.

    useTopicSchema

    Optional. When true, the output Cloud Storage file will be serialized using the topic schema, if it exists.

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 companion: AvroConfig.type
    Definition Classes
    AvroConfig → GeneratedMessage
  7. def discardUnknownFields: AvroConfig
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    AvroConfig → GeneratedMessage
  12. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    AvroConfig → GeneratedMessage
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. def serializedSize: Int
    Definition Classes
    AvroConfig → GeneratedMessage
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  21. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  22. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  23. def toProtoString: String
    Definition Classes
    AvroConfig → GeneratedMessage
  24. val unknownFields: UnknownFieldSet
  25. def update(ms: (Lens[AvroConfig, AvroConfig]) => Mutation[AvroConfig]*): AvroConfig
    Definition Classes
    Updatable
  26. val useTopicSchema: Boolean
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. def withUnknownFields(__v: UnknownFieldSet): AvroConfig
  31. def withUseTopicSchema(__v: Boolean): AvroConfig
  32. def withWriteMetadata(__v: Boolean): AvroConfig
  33. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  34. val writeMetadata: Boolean
  35. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    AvroConfig → GeneratedMessage
  36. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[AvroConfig]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped