Class BigtableConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BigtableConfig.Builder>
com.google.pubsub.v1.BigtableConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BigtableConfigOrBuilder, Cloneable
Enclosing class:
BigtableConfig

public static final class BigtableConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<BigtableConfig.Builder> 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
  • 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.Builder<BigtableConfig.Builder>
    • clear

      public BigtableConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<BigtableConfig.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<BigtableConfig.Builder>
    • getDefaultInstanceForType

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

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

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

      public BigtableConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BigtableConfig.Builder>
    • mergeFrom

      public BigtableConfig.Builder mergeFrom(BigtableConfig other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<BigtableConfig.Builder>
    • mergeFrom

      public BigtableConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BigtableConfig.Builder>
      Throws:
      IOException
    • 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.
    • setTable

      public BigtableConfig.Builder setTable(String value)
       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];
      Parameters:
      value - The table to set.
      Returns:
      This builder for chaining.
    • clearTable

      public BigtableConfig.Builder clearTable()
       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];
      Returns:
      This builder for chaining.
    • setTableBytes

      public BigtableConfig.Builder setTableBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for table to set.
      Returns:
      This builder for chaining.
    • 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.
    • setAppProfileId

      public BigtableConfig.Builder setAppProfileId(String value)
       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];
      Parameters:
      value - The appProfileId to set.
      Returns:
      This builder for chaining.
    • clearAppProfileId

      public BigtableConfig.Builder clearAppProfileId()
       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];
      Returns:
      This builder for chaining.
    • setAppProfileIdBytes

      public BigtableConfig.Builder setAppProfileIdBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for appProfileId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setServiceAccountEmail

      public BigtableConfig.Builder setServiceAccountEmail(String value)
       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];
      Parameters:
      value - The serviceAccountEmail to set.
      Returns:
      This builder for chaining.
    • clearServiceAccountEmail

      public BigtableConfig.Builder clearServiceAccountEmail()
       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];
      Returns:
      This builder for chaining.
    • setServiceAccountEmailBytes

      public BigtableConfig.Builder setServiceAccountEmailBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for serviceAccountEmail to set.
      Returns:
      This builder for chaining.
    • 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.
    • setWriteMetadata

      public BigtableConfig.Builder setWriteMetadata(boolean value)
       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];
      Parameters:
      value - The writeMetadata to set.
      Returns:
      This builder for chaining.
    • clearWriteMetadata

      public BigtableConfig.Builder clearWriteMetadata()
       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];
      Returns:
      This builder for chaining.
    • 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.
    • setStateValue

      public BigtableConfig.Builder setStateValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.
    • 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.
    • setState

       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];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.
    • clearState

      public BigtableConfig.Builder clearState()
       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];
      Returns:
      This builder for chaining.