org.apache.beam.sdk.io.gcp.pubsublite

Class PubsubLiteReadSchemaTransformProvider

java.lang.Object

org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>

org.apache.beam.sdk.io.gcp.pubsublite.PubsubLiteReadSchemaTransformProvider

All Implemented Interfaces:

SchemaTransformProvider

@AutoService(value=SchemaTransformProvider.class)
public class PubsubLiteReadSchemaTransformProvider
extends TypedSchemaTransformProvider<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubLiteReadSchemaTransformProvider.ErrorFn
static class	PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static TupleTag<Row>	ERROR_TAG
static TupleTag<Row>	OUTPUT_TAG
static java.util.Set<java.lang.String>	VALID_DATA_FORMATS
static java.lang.String	VALID_FORMATS_STR

Constructor Summary

Constructors

Constructor and Description
PubsubLiteReadSchemaTransformProvider()

Method Summary

Modifier and Type	Method and Description
static Schema	buildSchemaWithAttributes(Schema schema, java.util.List<java.lang.String> attributes, java.lang.String attributesMap) Builds a new Schema by adding additional optional attributes and map field to the provided schema.
protected java.lang.Class<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>	configurationClass()
java.lang.String	description() Returns a description regarding the SchemaTransform represented by the SchemaTransformProvider.
SchemaTransform	from(PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration configuration) Produce a SchemaTransform from ConfigT.
static SerializableFunction<byte[],Row>	getRawBytesToRowFunction(Schema rawSchema)
static SerializableFunction<com.google.cloud.pubsublite.proto.SequencedMessage,Uuid>	getUuidFromMessage(java.lang.String attributeId)
java.lang.String	identifier() Returns an id that uniquely represents this transform.
java.util.List<java.lang.String>	inputCollectionNames() Returns the input collection names of this transform.
java.util.List<java.lang.String>	outputCollectionNames() Returns the output collection names of this transform.

Methods inherited from class org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider

configurationSchema, dependencies, from

Methods inherited from class java.lang.Object

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

Field Detail

VALID_FORMATS_STR

public static final java.lang.String VALID_FORMATS_STR

See Also:

Constant Field Values

VALID_DATA_FORMATS

public static final java.util.Set<java.lang.String> VALID_DATA_FORMATS

OUTPUT_TAG

public static final TupleTag<Row> OUTPUT_TAG

ERROR_TAG

public static final TupleTag<Row> ERROR_TAG

Constructor Detail

PubsubLiteReadSchemaTransformProvider

public PubsubLiteReadSchemaTransformProvider()

Method Detail

configurationClass

protected java.lang.Class<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration> configurationClass()

Overrides:

configurationClass in class TypedSchemaTransformProvider<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>

description

public java.lang.String description()

Description copied from interface: SchemaTransformProvider

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.

from

public SchemaTransform from(PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration configuration)

Description copied from class: TypedSchemaTransformProvider

Produce a SchemaTransform from ConfigT. Can throw a InvalidConfigurationException or a InvalidSchemaException.

Specified by:

from in class TypedSchemaTransformProvider<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>

buildSchemaWithAttributes

public static Schema buildSchemaWithAttributes(Schema schema,
                                               java.util.List<java.lang.String> attributes,
                                               java.lang.String attributesMap)

Builds a new Schema by adding additional optional attributes and map field to the provided schema.

Parameters:

schema - The base schema to which additional attributes and map field will be added.

attributes - A list of optional attribute names to be added as STRING fields to the schema.

attributesMap - The name of the optional map field to be added to the schema. If empty, no map field will be added.

Returns:

A new Schema with the specified attributes and an optional map field.

Throws:

java.lang.IllegalArgumentException - if the schema is null or if any attribute name in the attributes list is null or empty.

getRawBytesToRowFunction

public static SerializableFunction<byte[],Row> getRawBytesToRowFunction(Schema rawSchema)

getUuidFromMessage

public static SerializableFunction<com.google.cloud.pubsublite.proto.SequencedMessage,Uuid> getUuidFromMessage(java.lang.String attributeId)

identifier

public java.lang.String identifier()

Description copied from interface: SchemaTransformProvider

Returns an id that uniquely represents this transform.

inputCollectionNames

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

Description copied from interface: SchemaTransformProvider

Returns the input collection names of this transform.

outputCollectionNames

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

Description copied from interface: SchemaTransformProvider

Returns the output collection names of this transform.