Package 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(SchemaTransformProvider.class)
public class PubsubLiteReadSchemaTransformProvider
extends TypedSchemaTransformProvider<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TupleTag<Row>	ERROR_TAG
static final TupleTag<Row>	OUTPUT_TAG
static final Set<String>	VALID_DATA_FORMATS
static final String	VALID_FORMATS_STR

Constructor Summary

Constructors

Constructor	Description
PubsubLiteReadSchemaTransformProvider()

Method Summary

Modifier and Type	Method	Description
static Schema	buildSchemaWithAttributes(Schema schema, List<String> attributes, String attributesMap)	Builds a new Schema by adding additional optional attributes and map field to the provided schema.
protected Class<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>	configurationClass()
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(String attributeId)
String	identifier()	Returns an id that uniquely represents this transform.
List<String>	inputCollectionNames()	Returns the input collection names of this transform.
List<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 Details

VALID_FORMATS_STR

public static final String VALID_FORMATS_STR

See Also:

• Constant Field Values

VALID_DATA_FORMATS

public static final Set<String> VALID_DATA_FORMATS

OUTPUT_TAG

public static final TupleTag<Row> OUTPUT_TAG

ERROR_TAG

public static final TupleTag<Row> ERROR_TAG

Constructor Details

PubsubLiteReadSchemaTransformProvider

public PubsubLiteReadSchemaTransformProvider()

Method Details

configurationClass

protected Class<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration> configurationClass()

Overrides:

configurationClass in class TypedSchemaTransformProvider<PubsubLiteReadSchemaTransformProvider.PubsubLiteReadSchemaTransformConfiguration>

description

public 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,
 List<String> attributes,
 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:

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(String attributeId)

identifier

public String identifier()

Description copied from interface: SchemaTransformProvider

Returns an id that uniquely represents this transform.

inputCollectionNames

public List<String> inputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the input collection names of this transform.

outputCollectionNames

public List<String> outputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the output collection names of this transform.