org.apache.beam.sdk.schemas.transforms

Interface SchemaTransformProvider

All Known Implementing Classes:

BigQueryDirectReadSchemaTransformProvider, BigQueryExportReadSchemaTransformProvider, BigQueryFileLoadsWriteSchemaTransformProvider, BigQueryStorageWriteApiSchemaTransformProvider, BigtableReadSchemaTransformProvider, BigtableWriteSchemaTransformProvider, CsvWriteTransformProvider, DebeziumReadSchemaTransformProvider, FileReadSchemaTransformProvider, FileWriteSchemaTransformProvider, FlattenTransformProvider, GenerateSequenceSchemaTransformProvider, IcebergReadSchemaTransformProvider, IcebergWriteSchemaTransformProvider, JavaExplodeTransformProvider, JavaFilterTransformProvider, JavaMapToFieldsTransformProvider, JdbcReadSchemaTransformProvider, JdbcWriteSchemaTransformProvider, JsonWriteTransformProvider, KafkaReadSchemaTransformProvider, KafkaWriteSchemaTransformProvider, LoggingTransformProvider, ManagedSchemaTransformProvider, PubsubLiteReadSchemaTransformProvider, PubsubLiteWriteSchemaTransformProvider, PubsubReadSchemaTransformProvider, PubsubWriteSchemaTransformProvider, SingleStoreSchemaTransformReadProvider, SingleStoreSchemaTransformWriteProvider, SpannerChangestreamsReadSchemaTransformProvider, SpannerReadSchemaTransformProvider, SpannerWriteSchemaTransformProvider, SqlTransformSchemaTransformProvider, TestSchemaTransformProvider, TypedSchemaTransformProvider, WindowIntoTransformProvider

@Internal
public interface SchemaTransformProvider

Provider to create SchemaTransform instances for use in Beam SQL and other SDKs.

Internal only: This interface is actively being worked on and it will likely change as we provide implementations for more standard Beam transforms. We provide no backwards compatibility guarantees and it should not be implemented outside of the Beam repository.

Method Summary

Modifier and Type	Method and Description
Schema	configurationSchema() Returns the expected schema of the configuration object.
default java.util.Optional<java.util.List<java.lang.String>>	dependencies(Row configuration, PipelineOptions options) List the dependencies needed for this transform.
default java.lang.String	description() Returns a description regarding the SchemaTransform represented by the SchemaTransformProvider.
SchemaTransform	from(Row configuration) Produce a SchemaTransform from some transform-specific configuration object.
java.lang.String	identifier() Returns an id that uniquely represents this transform.
default java.util.List<java.lang.String>	inputCollectionNames() Returns the input collection names of this transform.
default java.util.List<java.lang.String>	outputCollectionNames() Returns the output collection names of this transform.

Method Detail

identifier

java.lang.String identifier()

Returns an id that uniquely represents this transform.

description

default java.lang.String description()

Returns a description regarding the SchemaTransform represented by the SchemaTransformProvider. Please keep the language generic (i.e. not specific to any programming language). The description may be markdown formatted.

configurationSchema

Schema configurationSchema()

Returns the expected schema of the configuration object. Note this is distinct from the schema of the transform itself.

from

SchemaTransform from(Row configuration)

Produce a SchemaTransform from some transform-specific configuration object. Can throw a InvalidConfigurationException or a InvalidSchemaException.

inputCollectionNames

default java.util.List<java.lang.String> inputCollectionNames()

Returns the input collection names of this transform.

outputCollectionNames

default java.util.List<java.lang.String> outputCollectionNames()

Returns the output collection names of this transform.

dependencies

default java.util.Optional<java.util.List<java.lang.String>> dependencies(Row configuration,
                                                                          PipelineOptions options)

List the dependencies needed for this transform. Jars from classpath are used by default when Optional.empty() is returned.