Class: Google::Apis::PubsubV1::BigQueryConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

Configuration for a BigQuery subscription.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BigQueryConfig

Returns a new instance of BigQueryConfig.



122
123
124
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 122

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#drop_unknown_fields ⇒ Boolean Also known as: drop_unknown_fields?

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. Corresponds to the JSON property dropUnknownFields

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 81

def drop_unknown_fields
  @drop_unknown_fields
end

#state ⇒ String

Output only. An output-only field that indicates whether or not the subscription can receive messages. Corresponds to the JSON property state

Returns:

  • (String) 


88
89
90
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 88

def state
  @state
end

#table ⇒ String

Optional. The name of the table to which to write data, of the form projectId .datasetId.tableId Corresponds to the JSON property table

Returns:

  • (String) 


94
95
96
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 94

def table
  @table
end

#use_table_schema ⇒ Boolean Also known as: use_table_schema?

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. Corresponds to the JSON property useTableSchema

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 101

def use_table_schema
  @use_table_schema
end

#use_topic_schema ⇒ Boolean Also known as: use_topic_schema?

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. Corresponds to the JSON property useTopicSchema

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 109

def use_topic_schema
  @use_topic_schema
end

#write_metadata ⇒ Boolean Also known as: write_metadata?

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. Corresponds to the JSON property writeMetadata

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 119

def write_metadata
  @write_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



127
128
129
130
131
132
133
134
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 127

def update!(**args)
  @drop_unknown_fields = args[:drop_unknown_fields] if args.key?(:drop_unknown_fields)
  @state = args[:state] if args.key?(:state)
  @table = args[:table] if args.key?(:table)
  @use_table_schema = args[:use_table_schema] if args.key?(:use_table_schema)
  @use_topic_schema = args[:use_topic_schema] if args.key?(:use_topic_schema)
  @write_metadata = args[:write_metadata] if args.key?(:write_metadata)
end