org.apache.beam.sdk.io.gcp.spanner

Class SpannerConfig

java.lang.Object

org.apache.beam.sdk.io.gcp.spanner.SpannerConfig

All Implemented Interfaces:

java.io.Serializable

public abstract class SpannerConfig
extends java.lang.Object
implements java.io.Serializable

Configuration for a Cloud Spanner client.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpannerConfig.Builder Builder for SpannerConfig.

Constructor Summary

Constructors

Constructor and Description
SpannerConfig()

Method Summary

Modifier and Type	Method and Description
static SpannerConfig	create()
abstract @Nullable ValueProvider<Duration>	getCommitDeadline()
abstract @Nullable com.google.api.gax.retrying.RetrySettings	getCommitRetrySettings()
abstract @Nullable ValueProvider<java.lang.String>	getDatabaseId()
abstract @Nullable ValueProvider<java.lang.String>	getDatabaseRole()
abstract @Nullable ValueProvider<java.lang.Boolean>	getDataBoostEnabled()
abstract @Nullable ValueProvider<java.lang.String>	getEmulatorHost()
abstract @Nullable com.google.api.gax.retrying.RetrySettings	getExecuteStreamingSqlRetrySettings()
abstract @Nullable ValueProvider<java.lang.String>	getHost()
abstract @Nullable ValueProvider<java.lang.String>	getInstanceId()
abstract @Nullable ValueProvider<java.lang.Boolean>	getIsLocalChannelProvider()
abstract @Nullable ValueProvider<Duration>	getMaxCumulativeBackoff()
abstract @Nullable ValueProvider<Duration>	getPartitionQueryTimeout()
abstract @Nullable ValueProvider<Duration>	getPartitionReadTimeout()
abstract @Nullable ValueProvider<java.lang.String>	getProjectId()
abstract @Nullable org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableSet<com.google.api.gax.rpc.StatusCode.Code>	getRetryableCodes()
abstract @Nullable ValueProvider<com.google.cloud.spanner.Options.RpcPriority>	getRpcPriority()
void	populateDisplayData(DisplayData.Builder builder)
void	validate()
SpannerConfig	withCommitDeadline(Duration commitDeadline) Specifies the commit deadline.
SpannerConfig	withCommitDeadline(ValueProvider<Duration> commitDeadline) Specifies the commit deadline.
SpannerConfig	withCommitRetrySettings(com.google.api.gax.retrying.RetrySettings commitRetrySettings) Specifies the commit retry settings.
SpannerConfig	withDatabaseId(java.lang.String databaseId) Specifies the Cloud Spanner database ID.
SpannerConfig	withDatabaseId(ValueProvider<java.lang.String> databaseId) Specifies the Cloud Spanner database ID.
SpannerConfig	withDatabaseRole(ValueProvider<java.lang.String> databaseRole) Specifies the Cloud Spanner database role.
SpannerConfig	withDataBoostEnabled(ValueProvider<java.lang.Boolean> dataBoostEnabled) Specifies if the pipeline has to be run on the independent compute resource.
SpannerConfig	withEmulatorHost(ValueProvider<java.lang.String> emulatorHost) Specifies the Cloud Spanner host, when an emulator is used.
SpannerConfig	withExecuteStreamingSqlRetrySettings(com.google.api.gax.retrying.RetrySettings executeStreamingSqlRetrySettings) Specifies the ExecuteStreamingSql retry settings.
SpannerConfig	withHost(ValueProvider<java.lang.String> host) Specifies the Cloud Spanner host.
SpannerConfig	withInstanceId(java.lang.String instanceId) Specifies the Cloud Spanner instance ID.
SpannerConfig	withInstanceId(ValueProvider<java.lang.String> instanceId) Specifies the Cloud Spanner instance ID.
SpannerConfig	withIsLocalChannelProvider(ValueProvider<java.lang.Boolean> isLocalChannelProvider) Specifies whether a local channel provider should be used.
SpannerConfig	withMaxCumulativeBackoff(Duration maxCumulativeBackoff) Specifies the maximum cumulative backoff.
SpannerConfig	withMaxCumulativeBackoff(ValueProvider<Duration> maxCumulativeBackoff) Specifies the maximum cumulative backoff.
SpannerConfig	withPartitionQueryTimeout(Duration partitionQueryTimeout) Specifies the PartitionQuery timeout.
SpannerConfig	withPartitionQueryTimeout(ValueProvider<Duration> partitionQueryTimeout) Specifies the PartitionQuery timeout.
SpannerConfig	withPartitionReadTimeout(Duration partitionReadTimeout) Specifies the PartitionRead timeout.
SpannerConfig	withPartitionReadTimeout(ValueProvider<Duration> partitionReadTimeout) Specifies the PartitionRead timeout.
SpannerConfig	withProjectId(java.lang.String projectId) Specifies the Cloud Spanner project ID.
SpannerConfig	withProjectId(ValueProvider<java.lang.String> projectId) Specifies the Cloud Spanner project ID.
SpannerConfig	withRetryableCodes(org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableSet<com.google.api.gax.rpc.StatusCode.Code> retryableCodes) Specifies the errors that will be retried by the client library for all operations.
SpannerConfig	withRpcPriority(com.google.cloud.spanner.Options.RpcPriority rpcPriority) Specifies the RPC priority.
SpannerConfig	withRpcPriority(ValueProvider<com.google.cloud.spanner.Options.RpcPriority> rpcPriority) Specifies the RPC priority.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpannerConfig

public SpannerConfig()

Method Detail

getProjectId

public abstract @Nullable ValueProvider<java.lang.String> getProjectId()

getInstanceId

public abstract @Nullable ValueProvider<java.lang.String> getInstanceId()

getDatabaseId

public abstract @Nullable ValueProvider<java.lang.String> getDatabaseId()

getHost

public abstract @Nullable ValueProvider<java.lang.String> getHost()

getEmulatorHost

public abstract @Nullable ValueProvider<java.lang.String> getEmulatorHost()

getIsLocalChannelProvider

public abstract @Nullable ValueProvider<java.lang.Boolean> getIsLocalChannelProvider()

getCommitDeadline

public abstract @Nullable ValueProvider<Duration> getCommitDeadline()

getMaxCumulativeBackoff

public abstract @Nullable ValueProvider<Duration> getMaxCumulativeBackoff()

getExecuteStreamingSqlRetrySettings

public abstract @Nullable com.google.api.gax.retrying.RetrySettings getExecuteStreamingSqlRetrySettings()

getCommitRetrySettings

public abstract @Nullable com.google.api.gax.retrying.RetrySettings getCommitRetrySettings()

getRetryableCodes

public abstract @Nullable org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableSet<com.google.api.gax.rpc.StatusCode.Code> getRetryableCodes()

getRpcPriority

public abstract @Nullable ValueProvider<com.google.cloud.spanner.Options.RpcPriority> getRpcPriority()

getDatabaseRole

public abstract @Nullable ValueProvider<java.lang.String> getDatabaseRole()

getPartitionQueryTimeout

public abstract @Nullable ValueProvider<Duration> getPartitionQueryTimeout()

getPartitionReadTimeout

public abstract @Nullable ValueProvider<Duration> getPartitionReadTimeout()

getDataBoostEnabled

public abstract @Nullable ValueProvider<java.lang.Boolean> getDataBoostEnabled()

create

public static SpannerConfig create()

validate

public void validate()

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

withProjectId

public SpannerConfig withProjectId(ValueProvider<java.lang.String> projectId)

Specifies the Cloud Spanner project ID.

withProjectId

public SpannerConfig withProjectId(java.lang.String projectId)

Specifies the Cloud Spanner project ID.

withInstanceId

public SpannerConfig withInstanceId(ValueProvider<java.lang.String> instanceId)

Specifies the Cloud Spanner instance ID.

withInstanceId

public SpannerConfig withInstanceId(java.lang.String instanceId)

Specifies the Cloud Spanner instance ID.

withDatabaseId

public SpannerConfig withDatabaseId(ValueProvider<java.lang.String> databaseId)

Specifies the Cloud Spanner database ID.

withDatabaseId

public SpannerConfig withDatabaseId(java.lang.String databaseId)

Specifies the Cloud Spanner database ID.

withHost

public SpannerConfig withHost(ValueProvider<java.lang.String> host)

Specifies the Cloud Spanner host.

withEmulatorHost

public SpannerConfig withEmulatorHost(ValueProvider<java.lang.String> emulatorHost)

Specifies the Cloud Spanner host, when an emulator is used.

withIsLocalChannelProvider

public SpannerConfig withIsLocalChannelProvider(ValueProvider<java.lang.Boolean> isLocalChannelProvider)

Specifies whether a local channel provider should be used. This should be set to True when an emulator is used.

withCommitDeadline

public SpannerConfig withCommitDeadline(Duration commitDeadline)

Specifies the commit deadline. This is overridden if the CommitRetrySettings is specified.

withCommitDeadline

public SpannerConfig withCommitDeadline(ValueProvider<Duration> commitDeadline)

Specifies the commit deadline. This is overridden if the CommitRetrySettings is specified.

withMaxCumulativeBackoff

public SpannerConfig withMaxCumulativeBackoff(Duration maxCumulativeBackoff)

Specifies the maximum cumulative backoff.

withMaxCumulativeBackoff

public SpannerConfig withMaxCumulativeBackoff(ValueProvider<Duration> maxCumulativeBackoff)

Specifies the maximum cumulative backoff.

withExecuteStreamingSqlRetrySettings

public SpannerConfig withExecuteStreamingSqlRetrySettings(com.google.api.gax.retrying.RetrySettings executeStreamingSqlRetrySettings)

Specifies the ExecuteStreamingSql retry settings. If not set, the default timeout is set to 2 hours.

withCommitRetrySettings

public SpannerConfig withCommitRetrySettings(com.google.api.gax.retrying.RetrySettings commitRetrySettings)

Specifies the commit retry settings. Setting this overrides the commit deadline.

withRetryableCodes

public SpannerConfig withRetryableCodes(org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableSet<com.google.api.gax.rpc.StatusCode.Code> retryableCodes)

Specifies the errors that will be retried by the client library for all operations.

withRpcPriority

public SpannerConfig withRpcPriority(com.google.cloud.spanner.Options.RpcPriority rpcPriority)

Specifies the RPC priority.

withRpcPriority

public SpannerConfig withRpcPriority(ValueProvider<com.google.cloud.spanner.Options.RpcPriority> rpcPriority)

Specifies the RPC priority.

withDatabaseRole

public SpannerConfig withDatabaseRole(ValueProvider<java.lang.String> databaseRole)

Specifies the Cloud Spanner database role.

withDataBoostEnabled

public SpannerConfig withDataBoostEnabled(ValueProvider<java.lang.Boolean> dataBoostEnabled)

Specifies if the pipeline has to be run on the independent compute resource.

withPartitionQueryTimeout

public SpannerConfig withPartitionQueryTimeout(Duration partitionQueryTimeout)

Specifies the PartitionQuery timeout.

withPartitionQueryTimeout

public SpannerConfig withPartitionQueryTimeout(ValueProvider<Duration> partitionQueryTimeout)

Specifies the PartitionQuery timeout.

withPartitionReadTimeout

public SpannerConfig withPartitionReadTimeout(Duration partitionReadTimeout)

Specifies the PartitionRead timeout.

withPartitionReadTimeout

public SpannerConfig withPartitionReadTimeout(ValueProvider<Duration> partitionReadTimeout)

Specifies the PartitionRead timeout.