com.google.cloud.bigtable.beam

Class CloudBigtableScanConfiguration.Builder

java.lang.Object

com.google.cloud.bigtable.beam.CloudBigtableConfiguration.Builder

com.google.cloud.bigtable.beam.CloudBigtableTableConfiguration.Builder

com.google.cloud.bigtable.beam.CloudBigtableScanConfiguration.Builder

Enclosing class:

CloudBigtableScanConfiguration

public static class CloudBigtableScanConfiguration.Builder
extends CloudBigtableTableConfiguration.Builder

Builds a CloudBigtableScanConfiguration.

Field Summary

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

tableId

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

additionalConfiguration, instanceId, projectId

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CloudBigtableScanConfiguration	build() Builds the CloudBigtableScanConfiguration.
CloudBigtableScanConfiguration.Builder	withAppProfileId(String appProfileId) Specifies the AppProfile to use.
CloudBigtableScanConfiguration.Builder	withAppProfileId(ValueProvider<String> appProfileId) Specifies the AppProfile to use.
CloudBigtableScanConfiguration.Builder	withConfiguration(String key, String value) Adds additional connection configuration.
CloudBigtableScanConfiguration.Builder	withConfiguration(String key, ValueProvider<String> value) Adds additional connection configuration.
CloudBigtableScanConfiguration.Builder	withInstanceId(String instanceId) Specifies the Cloud Bigtable instanceId.
CloudBigtableScanConfiguration.Builder	withInstanceId(ValueProvider<String> instanceId) Specifies the Cloud Bigtable instanceId.
CloudBigtableScanConfiguration.Builder	withProjectId(String projectId) Specifies the project ID for the Cloud Bigtable instance.
CloudBigtableScanConfiguration.Builder	withProjectId(ValueProvider<String> projectId) Specifies the project ID for the Cloud Bigtable instance.
CloudBigtableScanConfiguration.Builder	withRequest(com.google.bigtable.repackaged.com.google.bigtable.v2.ReadRowsRequest request) Deprecated. Please use withScan(Scan) instead. Specifies the ReadRowsRequest that will be used to filter the table.
CloudBigtableScanConfiguration.Builder	withRequest(ValueProvider<com.google.bigtable.repackaged.com.google.bigtable.v2.ReadRowsRequest> request) Deprecated. Please use withScan(Scan) instead. Specifies the ReadRowsRequest that will be used to filter the table.
CloudBigtableScanConfiguration.Builder	withScan(Scan scan) Specifies the Scan that will be used to filter the table.
CloudBigtableScanConfiguration.Builder	withTableId(String tableId) Specifies the table to connect to.
CloudBigtableScanConfiguration.Builder	withTableId(ValueProvider<String> tableId) Specifies the table to connect to.

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

copyFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withScan

public CloudBigtableScanConfiguration.Builder withScan(Scan scan)

Specifies the Scan that will be used to filter the table.

Parameters:

scan - The Scan to add to the configuration.

Returns:

The CloudBigtableScanConfiguration.Builder for chaining convenience.

withRequest

@Deprecated
public CloudBigtableScanConfiguration.Builder withRequest(com.google.bigtable.repackaged.com.google.bigtable.v2.ReadRowsRequest request)

Deprecated. Please use withScan(Scan) instead.

Specifies the ReadRowsRequest that will be used to filter the table.

Parameters:

request - The ReadRowsRequest to add to the configuration.

Returns:

The CloudBigtableScanConfiguration.Builder for chaining convenience.

withRequest

@Deprecated
public CloudBigtableScanConfiguration.Builder withRequest(ValueProvider<com.google.bigtable.repackaged.com.google.bigtable.v2.ReadRowsRequest> request)

Deprecated. Please use withScan(Scan) instead.

Specifies the ReadRowsRequest that will be used to filter the table.

Parameters:

request - The ReadRowsRequest to add to the configuration.

Returns:

The CloudBigtableScanConfiguration.Builder for chaining convenience.

withProjectId

public CloudBigtableScanConfiguration.Builder withProjectId(String projectId)

Specifies the project ID for the Cloud Bigtable instance.

Overrides CloudBigtableConfiguration.Builder.withProjectId(String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides CloudBigtableTableConfiguration.Builder.withProjectId(String) so that it returns CloudBigtableScanConfiguration.Builder.

Overrides:

withProjectId in class CloudBigtableTableConfiguration.Builder

Parameters:

projectId - The project ID for the instance.

Returns:

The CloudBigtableConfiguration.Builder for chaining convenience.

withProjectId

public CloudBigtableScanConfiguration.Builder withProjectId(ValueProvider<String> projectId)

Specifies the project ID for the Cloud Bigtable instance.

Overrides CloudBigtableConfiguration.Builder.withProjectId(String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides CloudBigtableTableConfiguration.Builder.withProjectId(String) so that it returns CloudBigtableScanConfiguration.Builder.

Overrides:

withProjectId in class CloudBigtableTableConfiguration.Builder

Parameters:

projectId - The project ID for the instance.

Returns:

The CloudBigtableConfiguration.Builder for chaining convenience.

withInstanceId

public CloudBigtableScanConfiguration.Builder withInstanceId(String instanceId)

Specifies the Cloud Bigtable instanceId.

Overrides CloudBigtableConfiguration.Builder.withInstanceId(String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides:

withInstanceId in class CloudBigtableTableConfiguration.Builder

Parameters:

instanceId - The Cloud Bigtable instanceId.

Returns:

The CloudBigtableConfiguration.Builder for chaining convenience.

withInstanceId

public CloudBigtableScanConfiguration.Builder withInstanceId(ValueProvider<String> instanceId)

Specifies the Cloud Bigtable instanceId.

Overrides CloudBigtableConfiguration.Builder.withInstanceId(String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides:

withInstanceId in class CloudBigtableTableConfiguration.Builder

Parameters:

instanceId - The Cloud Bigtable instanceId.

Returns:

The CloudBigtableConfiguration.Builder for chaining convenience.

withAppProfileId

public CloudBigtableScanConfiguration.Builder withAppProfileId(String appProfileId)

Specifies the AppProfile to use.

Overrides CloudBigtableConfiguration.Builder.withAppProfileId(String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides:

withAppProfileId in class CloudBigtableTableConfiguration.Builder

withAppProfileId

public CloudBigtableScanConfiguration.Builder withAppProfileId(ValueProvider<String> appProfileId)

Specifies the AppProfile to use.

Overrides CloudBigtableConfiguration.Builder.withAppProfileId(String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides:

withAppProfileId in class CloudBigtableTableConfiguration.Builder

withConfiguration

public CloudBigtableScanConfiguration.Builder withConfiguration(String key,
                                                                String value)

Adds additional connection configuration. BigtableOptionsFactory for more information about configuration options.

Overrides CloudBigtableConfiguration.Builder.withConfiguration(String, String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides:

withConfiguration in class CloudBigtableTableConfiguration.Builder

Returns:

The CloudBigtableConfiguration.Builder for chaining convenience.

withConfiguration

public CloudBigtableScanConfiguration.Builder withConfiguration(String key,
                                                                ValueProvider<String> value)

Adds additional connection configuration. BigtableOptionsFactory for more information about configuration options.

Overrides CloudBigtableConfiguration.Builder.withConfiguration(String, String) so that it returns CloudBigtableTableConfiguration.Builder.

Overrides:

withConfiguration in class CloudBigtableTableConfiguration.Builder

Returns:

The CloudBigtableConfiguration.Builder for chaining convenience.

withTableId

public CloudBigtableScanConfiguration.Builder withTableId(String tableId)

Specifies the table to connect to.

Overrides CloudBigtableTableConfiguration.Builder.withTableId(String) so that it returns CloudBigtableScanConfiguration.Builder.

Overrides:

withTableId in class CloudBigtableTableConfiguration.Builder

Parameters:

tableId - The table to connect to.

Returns:

The CloudBigtableTableConfiguration.Builder for chaining convenience.

withTableId

public CloudBigtableScanConfiguration.Builder withTableId(ValueProvider<String> tableId)

Specifies the table to connect to. Overrides CloudBigtableTableConfiguration.Builder.withTableId(String) so that it returns CloudBigtableScanConfiguration.Builder.

Overrides:

withTableId in class CloudBigtableTableConfiguration.Builder

Parameters:

tableId - The table to connect to.

Returns:

The CloudBigtableTableConfiguration.Builder for chaining convenience.

build

public CloudBigtableScanConfiguration build()

Builds the CloudBigtableScanConfiguration.

Overrides:

build in class CloudBigtableTableConfiguration.Builder

Returns:

The new CloudBigtableScanConfiguration.