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

Class SpannerIO.ReadChangeStream

java.lang.Object
org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<DataChangeRecord>>
org.apache.beam.sdk.io.gcp.spanner.SpannerIO.ReadChangeStream
All Implemented Interfaces:
Serializable, HasDisplayData
Enclosing class:
SpannerIO
public abstract static class SpannerIO.ReadChangeStream extends PTransform<PBegin,PCollection<DataChangeRecord>>
See Also:

  • Constructor Details

    • ReadChangeStream

      public ReadChangeStream()

  • Method Details

    • withSpannerConfig

      public SpannerIO.ReadChangeStream withSpannerConfig(SpannerConfig spannerConfig)
      Specifies the Cloud Spanner configuration.

    • withProjectId

      public SpannerIO.ReadChangeStream withProjectId(String projectId)
      Specifies the Cloud Spanner project.

    • withProjectId

      public SpannerIO.ReadChangeStream withProjectId(ValueProvider<String> projectId)
      Specifies the Cloud Spanner project.

    • withInstanceId

      public SpannerIO.ReadChangeStream withInstanceId(String instanceId)
      Specifies the Cloud Spanner instance.

    • withInstanceId

      public SpannerIO.ReadChangeStream withInstanceId(ValueProvider<String> instanceId)
      Specifies the Cloud Spanner instance.

    • withDatabaseId

      public SpannerIO.ReadChangeStream withDatabaseId(String databaseId)
      Specifies the Cloud Spanner database.

    • withDatabaseId

      public SpannerIO.ReadChangeStream withDatabaseId(ValueProvider<String> databaseId)
      Specifies the Cloud Spanner database.

    • withChangeStreamName

      public SpannerIO.ReadChangeStream withChangeStreamName(String changeStreamName)
      Specifies the change stream name.

    • withMetadataInstance

      public SpannerIO.ReadChangeStream withMetadataInstance(String metadataInstance)
      Specifies the metadata database.

    • withMetadataDatabase

      public SpannerIO.ReadChangeStream withMetadataDatabase(String metadataDatabase)
      Specifies the metadata database.

    • withMetadataTable

      public SpannerIO.ReadChangeStream withMetadataTable(String metadataTable)
      Specifies the metadata table name.

    • withInclusiveStartAt

      public SpannerIO.ReadChangeStream withInclusiveStartAt(com.google.cloud.Timestamp timestamp)
      Specifies the time that the change stream should be read from.

    • withInclusiveEndAt

      public SpannerIO.ReadChangeStream withInclusiveEndAt(com.google.cloud.Timestamp timestamp)
      Specifies the end time of the change stream.

    • withRpcPriority

      public SpannerIO.ReadChangeStream withRpcPriority(com.google.cloud.spanner.Options.RpcPriority rpcPriority)
      Specifies the priority of the change stream queries.

    • withTraceSampleProbability

      @Deprecated public SpannerIO.ReadChangeStream withTraceSampleProbability(Double probability)
      Deprecated.
      This configuration has no effect, as tracing is not available.
      Specifies the sample probability of tracing requests.

    • withWatermarkRefreshRate

      public SpannerIO.ReadChangeStream withWatermarkRefreshRate(Duration refreshRate)

    • withExperimentalHost

      public SpannerIO.ReadChangeStream withExperimentalHost(ValueProvider<String> experimentalHost)
      Specifies the experimental host to set on SpannerOptions (setExperimentalHost).

    • withExperimentalHost

      public SpannerIO.ReadChangeStream withExperimentalHost(String experimentalHost)
      Specifies the experimental host to set on SpannerOptions (setExperimentalHost).

    • withUsingPlainTextChannel

      public SpannerIO.ReadChangeStream withUsingPlainTextChannel(ValueProvider<Boolean> plainText)
      Specifies whether to use plaintext channel.

      Note: This parameter is only valid when using an experimental host (set via withExperimentalHost).

    • withUsingPlainTextChannel

      public SpannerIO.ReadChangeStream withUsingPlainTextChannel(boolean plainText)
      Specifies whether to use plaintext channel.

      Note: This parameter is only valid when using an experimental host (set via withExperimentalHost).

    • expand

      public PCollection<DataChangeRecord> expand(PBegin input)
      Description copied from class: PTransform
      Override this method to specify how this PTransform should be expanded on the given InputT.

      NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

      Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

      Specified by:
      expand in class PTransform<PBegin,PCollection<DataChangeRecord>>