public final class BigQueryConfig extends GeneratedMessageV3 implements BigQueryConfigOrBuilder
Configuration for a BigQuery subscription.
Protobuf type google.pubsub.v1.BigQueryConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 |
|
STATE_FIELD_NUMBER
public static final int STATE_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 |
|
public static final int WRITE_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BigQueryConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BigQueryConfig.Builder newBuilder()
newBuilder(BigQueryConfig prototype)
public static BigQueryConfig.Builder newBuilder(BigQueryConfig prototype)
public static BigQueryConfig parseDelimitedFrom(InputStream input)
public static BigQueryConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BigQueryConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BigQueryConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BigQueryConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BigQueryConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BigQueryConfig parseFrom(CodedInputStream input)
public static BigQueryConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BigQueryConfig parseFrom(InputStream input)
public static BigQueryConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BigQueryConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BigQueryConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BigQueryConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BigQueryConfig getDefaultInstanceForType()
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()
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.
|
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];
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 |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
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.
|
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BigQueryConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BigQueryConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BigQueryConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
