final case class BigQueryConfig(table: String = "", useTopicSchema: Boolean = false, writeMetadata: Boolean = false, dropUnknownFields: Boolean = false, state: State = com.google.pubsub.v1.pubsub.BigQueryConfig.State.STATE_UNSPECIFIED, useTableSchema: Boolean = false, serviceAccountEmail: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BigQueryConfig] with Product with Serializable

Configuration for a BigQuery subscription.

table

Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

useTopicSchema

Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.

writeMetadata

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

dropUnknownFields

Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.

state

Output only. An output-only field that indicates whether or not the subscription can receive messages.

useTableSchema

Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.

serviceAccountEmail

Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

Annotations
@SerialVersionUID()
Source
BigQueryConfig.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BigQueryConfig
  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 BigQueryConfig(table: String = "", useTopicSchema: Boolean = false, writeMetadata: Boolean = false, dropUnknownFields: Boolean = false, state: State = com.google.pubsub.v1.pubsub.BigQueryConfig.State.STATE_UNSPECIFIED, useTableSchema: Boolean = false, serviceAccountEmail: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    table

    Optional. The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}

    useTopicSchema

    Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. use_topic_schema and use_table_schema cannot be enabled at the same time.

    writeMetadata

    Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

    dropUnknownFields

    Optional. When true and use_topic_schema is true, any fields that are a part of the topic schema that are not part of the BigQuery table schema are dropped when writing to BigQuery. Otherwise, the schemas must be kept in sync and any messages with extra fields are not written and remain in the subscription's backlog.

    state

    Output only. An output-only field that indicates whether or not the subscription can receive messages.

    useTableSchema

    Optional. When true, use the BigQuery table's schema as the columns to write to in BigQuery. use_table_schema and use_topic_schema cannot be enabled at the same time.

    serviceAccountEmail

    Optional. The service account to use to write to BigQuery. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

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

Inherited from Updatable[BigQueryConfig]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped