CloudBigtableConfiguration (Apache Beam + Cloud Bigtable Connector 1.4.0 API)

com.google.cloud.bigtable.beam

Class CloudBigtableConfiguration

• java.lang.Object
• • com.google.cloud.bigtable.beam.CloudBigtableConfiguration

• All Implemented Interfaces:

  Serializable

  Direct Known Subclasses:

  CloudBigtableTableConfiguration

  ---

  
  

  public class CloudBigtableConfiguration
  extends Object
  implements Serializable

  This class defines configuration that a Cloud Bigtable client needs to connect to a Cloud Bigtable instance.

  See Also:

  Serialized Form

• • Nested Class Summary

    Nested Classes 

    Modifier and Type	Class and Description
    static class	CloudBigtableConfiguration.Builder Builds a CloudBigtableConfiguration.

  • Field Summary

    Fields 

    Modifier and Type	Field and Description
    static String	VALUE_UNAVAILABLE

  • Constructor Summary

    Constructors 

    Modifier	Constructor and Description
    protected	CloudBigtableConfiguration(org.apache.beam.sdk.options.ValueProvider<String> projectId, org.apache.beam.sdk.options.ValueProvider<String> instanceId, Map<String,org.apache.beam.sdk.options.ValueProvider<String>> additionalConfiguration) Creates a CloudBigtableConfiguration using the specified project ID and instance ID.

  • Method Summary

    All Methods Static Methods Instance Methods Concrete Methods 

    Modifier and Type	Method and Description
    protected boolean	areParametersAccessible() Checks if the parameters are accessible.
    protected static void	checkNotNullOrEmpty(String value, String name)
    void	copyConfig(CloudBigtableConfiguration.Builder builder)
    boolean	equals(Object obj) Compares this configuration with the specified object.
    String	getAppProfileId() Get the Cloud Bigtable App Profile id.
    protected org.apache.beam.sdk.repackaged.com.google.common.collect.ImmutableMap<String,org.apache.beam.sdk.options.ValueProvider<String>>	getConfiguration() Gets an immutable copy of the configuration map.
    protected static <T> String	getDisplayValue(org.apache.beam.sdk.options.ValueProvider<T> parameter)
    String	getInstanceId() Gets the Cloud Bigtable instance id.
    String	getProjectId() Gets the project ID for the Cloud Bigtable instance.
    void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
    com.google.bigtable.repackaged.com.google.cloud.bigtable.config.BigtableOptions	toBigtableOptions() Converts the CloudBigtableConfiguration to a BigtableOptions object.
    CloudBigtableConfiguration.Builder	toBuilder() Creates a new CloudBigtableConfiguration.Builder object containing the existing configuration.
    org.apache.hadoop.conf.Configuration	toHBaseConfig() Converts the CloudBigtableConfiguration to an HBase Configuration.
    void	validate()

    • Methods inherited from class java.lang.Object

      clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • Field Detail

    • VALUE_UNAVAILABLE

      public static final String VALUE_UNAVAILABLE

      See Also:

      Constant Field Values

  • Constructor Detail

    • CloudBigtableConfiguration

      protected CloudBigtableConfiguration(org.apache.beam.sdk.options.ValueProvider<String> projectId,
                                           org.apache.beam.sdk.options.ValueProvider<String> instanceId,
                                           Map<String,org.apache.beam.sdk.options.ValueProvider<String>> additionalConfiguration)

      Creates a CloudBigtableConfiguration using the specified project ID and instance ID.

      Parameters:

      projectId - The project ID for the instance.

      instanceId - The instance ID.

      additionalConfiguration - A Map with additional connection configuration. See BigtableOptionsFactory.fromConfiguration(Configuration) for more information about configuration options.

  • Method Detail

    • getProjectId

      public String getProjectId()

      Gets the project ID for the Cloud Bigtable instance.

      Returns:

      The project ID for the instance.

    • getInstanceId

      public String getInstanceId()

      Gets the Cloud Bigtable instance id.

      Returns:

      The Cloud Bigtable instance id.

    • getAppProfileId

      public String getAppProfileId()

      Get the Cloud Bigtable App Profile id.

    • toBigtableOptions

      public com.google.bigtable.repackaged.com.google.cloud.bigtable.config.BigtableOptions toBigtableOptions()
                                                                                                        throws IOException

      Converts the CloudBigtableConfiguration to a BigtableOptions object.

      Returns:

      The BigtableOptions object.

      Throws:

      IOException

    • toHBaseConfig

      public org.apache.hadoop.conf.Configuration toHBaseConfig()

      Converts the CloudBigtableConfiguration to an HBase Configuration.

      Returns:

      The Configuration.

    • toBuilder

      public CloudBigtableConfiguration.Builder toBuilder()

      Creates a new CloudBigtableConfiguration.Builder object containing the existing configuration.

      Returns:

      A new CloudBigtableConfiguration.Builder.

    • getConfiguration

      protected org.apache.beam.sdk.repackaged.com.google.common.collect.ImmutableMap<String,org.apache.beam.sdk.options.ValueProvider<String>> getConfiguration()

      Gets an immutable copy of the configuration map.

    • equals

      public boolean equals(Object obj)

      Compares this configuration with the specified object.

      Overrides:

      equals in class Object

      Parameters:

      obj - The object to compare this configuration against.

      Returns:

      true if the given object has the same configuration, false otherwise.

    • copyConfig

      public void copyConfig(CloudBigtableConfiguration.Builder builder)

    • areParametersAccessible

      protected boolean areParametersAccessible()

      Checks if the parameters are accessible. Runtime parameters are not accessible at pipeline construction time.

    • getDisplayValue

      protected static <T> String getDisplayValue(org.apache.beam.sdk.options.ValueProvider<T> parameter)

      Type Parameters:

      T - parameter The runtime parameter.

      Returns:

      the String value of runtime parameter if the parameter is accessible, returns "Unavailable during pipeline construction" otherwise for debugging purpose.

    • populateDisplayData

      public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

    • checkNotNullOrEmpty

      protected static void checkNotNullOrEmpty(String value,
                                                String name)

    • validate

      public void validate()