Class BigQueryConfig (0.61.0) 

public final class BigQueryConfig extends GeneratedMessageV3 implements BigQueryConfigOrBuilder

Configuration for a BigQuery subscription.

Protobuf type google.cloud.bigquery.analyticshub.v1.BigQueryConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BigQueryConfig

Static Fields

DROP_UNKNOWN_FIELDS_FIELD_NUMBER

public static final int DROP_UNKNOWN_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
Type Description
int

USE_TABLE_SCHEMA_FIELD_NUMBER

public static final int USE_TABLE_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

USE_TOPIC_SCHEMA_FIELD_NUMBER

public static final int USE_TOPIC_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

WRITE_METADATA_FIELD_NUMBER

public static final int WRITE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BigQueryConfig getDefaultInstance()
Returns
Type Description
BigQueryConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BigQueryConfig.Builder newBuilder()
Returns
Type Description
BigQueryConfig.Builder

newBuilder(BigQueryConfig prototype)

public static BigQueryConfig.Builder newBuilder(BigQueryConfig prototype)
Parameter
Name Description
prototype BigQueryConfig
Returns
Type Description
BigQueryConfig.Builder

parseDelimitedFrom(InputStream input)

public static BigQueryConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BigQueryConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigQueryConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigQueryConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BigQueryConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BigQueryConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigQueryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigQueryConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BigQueryConfig> parser()
Returns
Type Description
Parser<BigQueryConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BigQueryConfig getDefaultInstanceForType()
Returns
Type Description
BigQueryConfig

getDropUnknownFields()

public 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
Type Description
boolean

The dropUnknownFields.

getParserForType()

public Parser<BigQueryConfig> getParserForType()
Returns
Type Description
Parser<BigQueryConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountEmail()

public String getServiceAccountEmail()

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, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

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, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

getTable()

public 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
Type Description
String

The table.

getTableBytes()

public 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
Type Description
ByteString

The bytes for table.

getUseTableSchema()

public 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
Type Description
boolean

The useTableSchema.

getUseTopicSchema()

public 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
Type Description
boolean

The useTopicSchema.

getWriteMetadata()

public 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
Type Description
boolean

The writeMetadata.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BigQueryConfig.Builder newBuilderForType()
Returns
Type Description
BigQueryConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigQueryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BigQueryConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BigQueryConfig.Builder toBuilder()
Returns
Type Description
BigQueryConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException