Interface BigQueryConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BigQueryConfig, BigQueryConfig.Builder

public interface BigQueryConfigOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Optional.
    Output only.
    int
    Output only.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    boolean
    Optional.
    boolean
    Optional.
    boolean
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getTable

      String getTable()
       Optional. The name of the table to which to write data, of the form
       {projectId}.{datasetId}.{tableId}
       
      string table = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The table.
    • getTableBytes

      com.google.protobuf.ByteString getTableBytes()
       Optional. The name of the table to which to write data, of the form
       {projectId}.{datasetId}.{tableId}
       
      string table = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for table.
    • getUseTopicSchema

      boolean getUseTopicSchema()
       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.
       
      bool use_topic_schema = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The useTopicSchema.
    • getWriteMetadata

      boolean getWriteMetadata()
       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.
       
      bool write_metadata = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The writeMetadata.
    • getDropUnknownFields

      boolean getDropUnknownFields()
       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.
       
      bool drop_unknown_fields = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The dropUnknownFields.
    • getStateValue

      int getStateValue()
       Output only. An output-only field that indicates whether or not the
       subscription can receive messages.
       
      .google.pubsub.v1.BigQueryConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

       Output only. An output-only field that indicates whether or not the
       subscription can receive messages.
       
      .google.pubsub.v1.BigQueryConfig.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • getUseTableSchema

      boolean getUseTableSchema()
       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.
       
      bool use_table_schema = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The useTableSchema.