Class BigQueryConfig (1.120.23)

public final class BigQueryConfig extends GeneratedMessageV3 implements BigQueryConfigOrBuilder

Configuration for a BigQuery subscription.

Protobuf type google.pubsub.v1.BigQueryConfig

Static Fields

DROP_UNKNOWN_FIELDS_FIELD_NUMBER

public static final int DROP_UNKNOWN_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
TypeDescription
int

USE_TOPIC_SCHEMA_FIELD_NUMBER

public static final int USE_TOPIC_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

WRITE_METADATA_FIELD_NUMBER

public static final int WRITE_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BigQueryConfig getDefaultInstance()
Returns
TypeDescription
BigQueryConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BigQueryConfig.Builder newBuilder()
Returns
TypeDescription
BigQueryConfig.Builder

newBuilder(BigQueryConfig prototype)

public static BigQueryConfig.Builder newBuilder(BigQueryConfig prototype)
Parameter
NameDescription
prototypeBigQueryConfig
Returns
TypeDescription
BigQueryConfig.Builder

parseDelimitedFrom(InputStream input)

public static BigQueryConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BigQueryConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigQueryConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigQueryConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BigQueryConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BigQueryConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BigQueryConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BigQueryConfig> parser()
Returns
TypeDescription
Parser<BigQueryConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BigQueryConfig getDefaultInstanceForType()
Returns
TypeDescription
BigQueryConfig

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.

bool drop_unknown_fields = 4;

Returns
TypeDescription
boolean

The dropUnknownFields.

getParserForType()

public Parser<BigQueryConfig> getParserForType()
Returns
TypeDescription
Parser<BigQueryConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public BigQueryConfig.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
TypeDescription
BigQueryConfig.State

The state.

getStateValue()

public 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
TypeDescription
int

The enum numeric value on the wire for state.

getTable()

public String getTable()

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

string table = 1;

Returns
TypeDescription
String

The table.

getTableBytes()

public ByteString getTableBytes()

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

string table = 1;

Returns
TypeDescription
ByteString

The bytes for table.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUseTopicSchema()

public boolean getUseTopicSchema()

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

bool use_topic_schema = 2;

Returns
TypeDescription
boolean

The useTopicSchema.

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.

bool write_metadata = 3;

Returns
TypeDescription
boolean

The writeMetadata.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BigQueryConfig.Builder newBuilderForType()
Returns
TypeDescription
BigQueryConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigQueryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BigQueryConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BigQueryConfig.Builder toBuilder()
Returns
TypeDescription
BigQueryConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException