Package com.google.pubsub.v1

Class BigQueryConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.pubsub.v1.BigQueryConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BigQueryConfigOrBuilder, Serializable
public final class BigQueryConfig extends com.google.protobuf.GeneratedMessageV3 implements BigQueryConfigOrBuilder
 Configuration for a BigQuery subscription.
Protobuf type google.pubsub.v1.BigQueryConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BigQueryConfig.Builder
    Configuration for a BigQuery subscription.
    static enum 
    BigQueryConfig.State
    Possible states for a BigQuery subscription.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DROP_UNKNOWN_FIELDS_FIELD_NUMBER
     
    static final int
    SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     
    static final int
    TABLE_FIELD_NUMBER
     
    static final int
    USE_TABLE_SCHEMA_FIELD_NUMBER
     
    static final int
    USE_TOPIC_SCHEMA_FIELD_NUMBER
     
    static final int
    WRITE_METADATA_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static BigQueryConfig
    getDefaultInstance()
     
    BigQueryConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDropUnknownFields()
    Optional.
    com.google.protobuf.Parser<BigQueryConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getServiceAccountEmail()
    Optional.
    com.google.protobuf.ByteString
    getServiceAccountEmailBytes()
    Optional.
    BigQueryConfig.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    String
    getTable()
    Optional.
    com.google.protobuf.ByteString
    getTableBytes()
    Optional.
    boolean
    getUseTableSchema()
    Optional.
    boolean
    getUseTopicSchema()
    Optional.
    boolean
    getWriteMetadata()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BigQueryConfig.Builder
    newBuilder()
     
    static BigQueryConfig.Builder
    newBuilder(BigQueryConfig prototype)
     
    BigQueryConfig.Builder
    newBuilderForType()
     
    protected BigQueryConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static BigQueryConfig
    parseDelimitedFrom(InputStream input)
     
    static BigQueryConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigQueryConfig
    parseFrom(byte[] data)
     
    static BigQueryConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigQueryConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static BigQueryConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigQueryConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BigQueryConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigQueryConfig
    parseFrom(InputStream input)
     
    static BigQueryConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigQueryConfig
    parseFrom(ByteBuffer data)
     
    static BigQueryConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BigQueryConfig>
    parser()
     
    BigQueryConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • TABLE_FIELD_NUMBER

      public static final int TABLE_FIELD_NUMBER
      See Also:

    • USE_TOPIC_SCHEMA_FIELD_NUMBER

      public static final int USE_TOPIC_SCHEMA_FIELD_NUMBER
      See Also:

    • WRITE_METADATA_FIELD_NUMBER

      public static final int WRITE_METADATA_FIELD_NUMBER
      See Also:

    • DROP_UNKNOWN_FIELDS_FIELD_NUMBER

      public static final int DROP_UNKNOWN_FIELDS_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • USE_TABLE_SCHEMA_FIELD_NUMBER

      public static final int USE_TABLE_SCHEMA_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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];
      Specified by:
      getTable in interface BigQueryConfigOrBuilder
      Returns:
      The table.

    • getTableBytes

      public com.google.protobuf.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];
      Specified by:
      getTableBytes in interface BigQueryConfigOrBuilder
      Returns:
      The bytes for table.

    • 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];
      Specified by:
      getUseTopicSchema in interface BigQueryConfigOrBuilder
      Returns:
      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];
      Specified by:
      getWriteMetadata in interface BigQueryConfigOrBuilder
      Returns:
      The writeMetadata.

    • 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];
      Specified by:
      getDropUnknownFields in interface BigQueryConfigOrBuilder
      Returns:
      The dropUnknownFields.

    • 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];
      Specified by:
      getStateValue in interface BigQueryConfigOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface BigQueryConfigOrBuilder
      Returns:
      The state.

    • 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];
      Specified by:
      getUseTableSchema in interface BigQueryConfigOrBuilder
      Returns:
      The useTableSchema.

    • 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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
      string service_account_email = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getServiceAccountEmail in interface BigQueryConfigOrBuilder
      Returns:
      The serviceAccountEmail.

    • getServiceAccountEmailBytes

      public com.google.protobuf.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](https://cloud.google.com/iam/docs/service-agents),
 service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
      string service_account_email = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getServiceAccountEmailBytes in interface BigQueryConfigOrBuilder
      Returns:
      The bytes for serviceAccountEmail.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static BigQueryConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BigQueryConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BigQueryConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BigQueryConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BigQueryConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BigQueryConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BigQueryConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BigQueryConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BigQueryConfig.Builder newBuilder()

    • newBuilder

      public static BigQueryConfig.Builder newBuilder(BigQueryConfig prototype)

    • toBuilder

      public BigQueryConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BigQueryConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static BigQueryConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BigQueryConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<BigQueryConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public BigQueryConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder