com.google.cloud.bigtable.beam

Class CloudBigtableScanConfiguration

java.lang.Object

com.google.cloud.bigtable.beam.CloudBigtableConfiguration

com.google.cloud.bigtable.beam.CloudBigtableTableConfiguration

com.google.cloud.bigtable.beam.CloudBigtableScanConfiguration

All Implemented Interfaces:

Serializable

@InternalExtensionOnly
public class CloudBigtableScanConfiguration
extends CloudBigtableTableConfiguration

This class defines configuration that a Cloud Bigtable client needs to connect to a user's Cloud Bigtable instance; a table to connect to in the instance; and a filter on the table in the form of a Scan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PLACEHOLDER_APP_PROFILE_ID
protected static String	PLACEHOLDER_INSTANCE_ID
protected static String	PLACEHOLDER_PROJECT_ID
protected static String	PLACEHOLDER_TABLE_ID

Fields inherited from class com.google.cloud.bigtable.beam.CloudBigtableTableConfiguration

tableId

Fields inherited from class com.google.cloud.bigtable.beam.CloudBigtableConfiguration

VALUE_UNAVAILABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudBigtableScanConfiguration(ValueProvider<String> projectId, ValueProvider<String> instanceId, ValueProvider<String> tableId, ValueProvider<Scan> scanValueProvider, Map<String,ValueProvider<String>> additionalConfiguration) Creates a CloudBigtableScanConfiguration using the specified project ID, instance ID, table ID, Scan and additional connection configuration.

Method Summary

Modifier and Type	Method and Description
void	copyConfig(CloudBigtableScanConfiguration.Builder builder)
static CloudBigtableScanConfiguration	createConfig(ValueProvider<String> projectId, ValueProvider<String> instanceId, ValueProvider<String> tableId, ValueProvider<Scan> scan, Map<String,ValueProvider<String>> configuration) Converts configuration map to a CloudBigtableScanConfiguration.
boolean	equals(Object obj) Compares this configuration with the specified object.
static CloudBigtableScanConfiguration	fromConfig(CloudBigtableTableConfiguration config, Scan scan) Converts a CloudBigtableTableConfiguration object to a CloudBigtableScanConfiguration that will perform the specified Scan on the table.
com.google.bigtable.repackaged.com.google.bigtable.v2.ReadRowsRequest	getRequest() Deprecated.
ValueProvider<Scan>	getScanValueProvider()
byte[]	getStartRow()
byte[]	getStopRow()
void	populateDisplayData(DisplayData.Builder builder)
CloudBigtableScanConfiguration.Builder	toBuilder() Creates a new CloudBigtableConfiguration.Builder object containing the existing configuration.
ByteKeyRange	toByteKeyRange() Creates a ByteKeyRange representing the start and stop keys for this instance.

Methods inherited from class com.google.cloud.bigtable.beam.CloudBigtableTableConfiguration

copyConfig, getTableId, getTableIdValueProvider, validate

Methods inherited from class com.google.cloud.bigtable.beam.CloudBigtableConfiguration

areParametersAccessible, checkNotNullOrEmpty, copyConfig, getAppProfileId, getConfiguration, getDisplayValue, getInstanceId, getProjectId, toHBaseConfig

Methods inherited from class java.lang.Object

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

Field Detail

PLACEHOLDER_TABLE_ID

protected static final String PLACEHOLDER_TABLE_ID

See Also:

Constant Field Values

PLACEHOLDER_PROJECT_ID

protected static final String PLACEHOLDER_PROJECT_ID

See Also:

Constant Field Values

PLACEHOLDER_INSTANCE_ID

protected static final String PLACEHOLDER_INSTANCE_ID

See Also:

Constant Field Values

PLACEHOLDER_APP_PROFILE_ID

protected static final String PLACEHOLDER_APP_PROFILE_ID

See Also:

Constant Field Values

Constructor Detail

CloudBigtableScanConfiguration

protected CloudBigtableScanConfiguration(ValueProvider<String> projectId,
                                         ValueProvider<String> instanceId,
                                         ValueProvider<String> tableId,
                                         ValueProvider<Scan> scanValueProvider,
                                         Map<String,ValueProvider<String>> additionalConfiguration)

Creates a CloudBigtableScanConfiguration using the specified project ID, instance ID, table ID, Scan and additional connection configuration.

Parameters:

projectId - The project ID for the instance.

instanceId - The instance ID.

tableId - The table to connect to in the instance.

scanValueProvider - The Scan that will be used to filter the table.

additionalConfiguration - A Map with additional connection configuration.

Method Detail

fromConfig

public static CloudBigtableScanConfiguration fromConfig(CloudBigtableTableConfiguration config,
                                                        Scan scan)

Converts a CloudBigtableTableConfiguration object to a CloudBigtableScanConfiguration that will perform the specified Scan on the table.

Parameters:

config - The CloudBigtableTableConfiguration object.

scan - The Scan to add to the configuration.

Returns:

The new CloudBigtableScanConfiguration.

createConfig

public static CloudBigtableScanConfiguration createConfig(ValueProvider<String> projectId,
                                                          ValueProvider<String> instanceId,
                                                          ValueProvider<String> tableId,
                                                          ValueProvider<Scan> scan,
                                                          Map<String,ValueProvider<String>> configuration)

Converts configuration map to a CloudBigtableScanConfiguration.

Parameters:

projectId - Value provider for project id

instanceId - Value provider for instance id

tableId - table id

scan - The Scan to add to the configuration

configuration - A map of all the configurations

Returns:

getRequest

@Deprecated
public com.google.bigtable.repackaged.com.google.bigtable.v2.ReadRowsRequest getRequest()

Deprecated.

Gets the Scan used to filter the table.

Returns:

The Scan.

getScanValueProvider

public ValueProvider<Scan> getScanValueProvider()

getStartRow

public byte[] getStartRow()

Returns:

The start row for this configuration.

getStopRow

public byte[] getStopRow()

Returns:

The stop row for this configuration.

equals

public boolean equals(Object obj)

Description copied from class: CloudBigtableConfiguration

Compares this configuration with the specified object.

Overrides:

equals in class CloudBigtableTableConfiguration

Parameters:

obj - The object to compare this configuration against.

Returns:

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

toBuilder

public CloudBigtableScanConfiguration.Builder toBuilder()

Description copied from class: CloudBigtableConfiguration

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

Overrides:

toBuilder in class CloudBigtableTableConfiguration

Returns:

A new CloudBigtableConfiguration.Builder.

copyConfig

public void copyConfig(CloudBigtableScanConfiguration.Builder builder)

toByteKeyRange

public ByteKeyRange toByteKeyRange()

Creates a ByteKeyRange representing the start and stop keys for this instance.

Returns:

A ByteKeyRange.

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Overrides:

populateDisplayData in class CloudBigtableTableConfiguration