CloudBigtableConfiguration (Apache Beam + Cloud Bigtable Connector 1.4.0 API)

com.google.cloud.bigtable.beam

Class CloudBigtableConfiguration

    • 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.
      • 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.
      • 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()


Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Bigtable Documentation