Interface SchemaTransformProvider

  • All Known Implementing Classes:
    TypedSchemaTransformProvider

    @Internal
    @Experimental(SCHEMAS)
    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 Detail

      • identifier

        java.lang.String identifier()
        Returns an id that uniquely represents this transform.
      • 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 some transform-specific configuration object. Can throw a InvalidConfigurationException or a InvalidSchemaException.
      • inputCollectionNames

        java.util.List<java.lang.String> inputCollectionNames()
        Returns the input collection names of this transform.
      • outputCollectionNames

        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.