Package com.google.pubsub.v1

Class BigtableConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.pubsub.v1.BigtableConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BigtableConfigOrBuilder, Serializable
@Generated public final class BigtableConfig extends com.google.protobuf.GeneratedMessage implements BigtableConfigOrBuilder
 Configuration for a Bigtable subscription. The Pub/Sub message will be
 written to a Bigtable row as follows:
 - row key: subscription name and message ID delimited by #.
 - columns: message bytes written to a single column family "data" with an
 empty-string column qualifier.
 - cell timestamp: the message publish timestamp.
Protobuf type google.pubsub.v1.BigtableConfig
See Also:

  • Nested Class Summary

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

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

    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
    APP_PROFILE_ID_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
    WRITE_METADATA_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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)
     
    String
    getAppProfileId()
    Optional.
    com.google.protobuf.ByteString
    getAppProfileIdBytes()
    Optional.
    static BigtableConfig
    getDefaultInstance()
     
    BigtableConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<BigtableConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getServiceAccountEmail()
    Optional.
    com.google.protobuf.ByteString
    getServiceAccountEmailBytes()
    Optional.
    BigtableConfig.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    String
    getTable()
    Optional.
    com.google.protobuf.ByteString
    getTableBytes()
    Optional.
    boolean
    getWriteMetadata()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BigtableConfig.Builder
    newBuilder()
     
    static BigtableConfig.Builder
    newBuilder(BigtableConfig prototype)
     
    BigtableConfig.Builder
    newBuilderForType()
     
    protected BigtableConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static BigtableConfig
    parseDelimitedFrom(InputStream input)
     
    static BigtableConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigtableConfig
    parseFrom(byte[] data)
     
    static BigtableConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigtableConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static BigtableConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigtableConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BigtableConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigtableConfig
    parseFrom(InputStream input)
     
    static BigtableConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BigtableConfig
    parseFrom(ByteBuffer data)
     
    static BigtableConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BigtableConfig>
    parser()
     
    BigtableConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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:

    • APP_PROFILE_ID_FIELD_NUMBER

      public static final int APP_PROFILE_ID_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
      See Also:

    • WRITE_METADATA_FIELD_NUMBER

      public static final int WRITE_METADATA_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getTable

      public String getTable()
       Optional. The unique name of the table to write messages to.

 Values are of the form
 `projects/<project>/instances/<instance>/tables/<table>`.
      string table = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTable in interface BigtableConfigOrBuilder
      Returns:
      The table.

    • getTableBytes

      public com.google.protobuf.ByteString getTableBytes()
       Optional. The unique name of the table to write messages to.

 Values are of the form
 `projects/<project>/instances/<instance>/tables/<table>`.
      string table = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTableBytes in interface BigtableConfigOrBuilder
      Returns:
      The bytes for table.

    • getAppProfileId

      public String getAppProfileId()
       Optional. The app profile to use for the Bigtable writes. If not specified,
 the "default" application profile will be used. The app profile must use
 single-cluster routing.
      string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAppProfileId in interface BigtableConfigOrBuilder
      Returns:
      The appProfileId.

    • getAppProfileIdBytes

      public com.google.protobuf.ByteString getAppProfileIdBytes()
       Optional. The app profile to use for the Bigtable writes. If not specified,
 the "default" application profile will be used. The app profile must use
 single-cluster routing.
      string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAppProfileIdBytes in interface BigtableConfigOrBuilder
      Returns:
      The bytes for appProfileId.

    • getServiceAccountEmail

      public String getServiceAccountEmail()
       Optional. The service account to use to write to Bigtable. 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getServiceAccountEmail in interface BigtableConfigOrBuilder
      Returns:
      The serviceAccountEmail.

    • getServiceAccountEmailBytes

      public com.google.protobuf.ByteString getServiceAccountEmailBytes()
       Optional. The service account to use to write to Bigtable. 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getServiceAccountEmailBytes in interface BigtableConfigOrBuilder
      Returns:
      The bytes for serviceAccountEmail.

    • 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 under the
 pubsub_metadata column family. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWriteMetadata in interface BigtableConfigOrBuilder
      Returns:
      The writeMetadata.

    • getStateValue

      public int getStateValue()
       Output only. An output-only field that indicates whether or not the
 subscription can receive messages.
      .google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface BigtableConfigOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public BigtableConfig.State getState()
       Output only. An output-only field that indicates whether or not the
 subscription can receive messages.
      .google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface BigtableConfigOrBuilder
      Returns:
      The state.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 BigtableConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BigtableConfig.Builder newBuilder()

    • newBuilder

      public static BigtableConfig.Builder newBuilder(BigtableConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected BigtableConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BigtableConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<BigtableConfig> 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.GeneratedMessage

    • getDefaultInstanceForType

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