com.google.api.services.pubsub.model

Class BigQueryConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pubsub.model.BigQueryConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BigQueryConfig
extends GenericJson

Configuration for a BigQuery subscription.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BigQueryConfig()

Method Summary

Modifier and Type	Method and Description
BigQueryConfig	clone()
Boolean	getDropUnknownFields() 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.
String	getState() Output only.
String	getTable() The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
Boolean	getUseTopicSchema() When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
Boolean	getWriteMetadata() When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table.
BigQueryConfig	set(String fieldName, Object value)
BigQueryConfig	setDropUnknownFields(Boolean dropUnknownFields) 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.
BigQueryConfig	setState(String state) Output only.
BigQueryConfig	setTable(String table) The name of the table to which to write data, of the form {projectId}.{datasetId}.{tableId}
BigQueryConfig	setUseTopicSchema(Boolean useTopicSchema) When true, use the topic's schema as the columns to write to in BigQuery, if it exists.
BigQueryConfig	setWriteMetadata(Boolean writeMetadata) When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BigQueryConfig

public BigQueryConfig()

Method Detail

getDropUnknownFields

public Boolean getDropUnknownFields()

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.

Returns:

value or null for none

setDropUnknownFields

public BigQueryConfig setDropUnknownFields(Boolean dropUnknownFields)

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.

Parameters:

dropUnknownFields - dropUnknownFields or null for none

getState

public String getState()

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

Returns:

value or null for none

setState

public BigQueryConfig setState(String state)

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

Parameters:

state - state or null for none

getTable

public String getTable()

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

Returns:

value or null for none

setTable

public BigQueryConfig setTable(String table)

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

Parameters:

table - table or null for none

getUseTopicSchema

public Boolean getUseTopicSchema()

When true, use the topic's schema as the columns to write to in BigQuery, if it exists.

Returns:

value or null for none

setUseTopicSchema

public BigQueryConfig setUseTopicSchema(Boolean useTopicSchema)

When true, use the topic's schema as the columns to write to in BigQuery, if it exists.

Parameters:

useTopicSchema - useTopicSchema or null for none

getWriteMetadata

public Boolean getWriteMetadata()

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.

Returns:

value or null for none

setWriteMetadata

public BigQueryConfig setWriteMetadata(Boolean writeMetadata)

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.

Parameters:

writeMetadata - writeMetadata or null for none

set

public BigQueryConfig set(String fieldName,
                          Object value)

Overrides:

set in class GenericJson

clone

public BigQueryConfig clone()

Overrides:

clone in class GenericJson