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

Class PubsubLiteWriteSchemaTransformProvider.PubsubLiteWriteSchemaTransformConfiguration

java.lang.Object

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

Enclosing class:

PubsubLiteWriteSchemaTransformProvider

@DefaultSchema(value=AutoValueSchema.class)
public abstract static class PubsubLiteWriteSchemaTransformProvider.PubsubLiteWriteSchemaTransformConfiguration
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubLiteWriteSchemaTransformProvider.PubsubLiteWriteSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor and Description
PubsubLiteWriteSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method and Description
static PubsubLiteWriteSchemaTransformProvider.PubsubLiteWriteSchemaTransformConfiguration.Builder	builder()
abstract @Nullable java.lang.String	getAttributeId()
abstract @Nullable java.util.List<java.lang.String>	getAttributes()
abstract @Nullable ErrorHandling	getErrorHandling()
abstract @Nullable java.lang.String	getFileDescriptorPath()
abstract java.lang.String	getFormat()
abstract java.lang.String	getLocation()
abstract @Nullable java.lang.String	getMessageName()
abstract java.lang.String	getProject()
abstract @Nullable java.lang.String	getSchema()
abstract java.lang.String	getTopicName()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

PubsubLiteWriteSchemaTransformConfiguration

public PubsubLiteWriteSchemaTransformConfiguration()

Method Detail

validate

public void validate()

getProject

@SchemaFieldDescription(value="The GCP project where the Pubsub Lite reservation resides. This can be a project number of a project ID.")
public abstract java.lang.String getProject()

getLocation

@SchemaFieldDescription(value="The region or zone where the Pubsub Lite reservation resides.")
public abstract java.lang.String getLocation()

getTopicName

@SchemaFieldDescription(value="The name of the topic to publish data into. This will be concatenated with the project and location parameters to build a full topic path.")
public abstract java.lang.String getTopicName()

getFormat

@SchemaFieldDescription(value="The encoding format for the data stored in Pubsub Lite. Valid options are: RAW,JSON,AVRO,PROTO")
public abstract java.lang.String getFormat()

getErrorHandling

@SchemaFieldDescription(value="This option specifies whether and where to output unwritable rows.")
public abstract @Nullable ErrorHandling getErrorHandling()

getAttributes

@SchemaFieldDescription(value="List of attribute keys whose values will be pulled out as Pubsub Lite message attributes.  For example, if the format is `JSON` and attributes is `[\"a\", \"b\"]` then elements of the form `Row(any_field=..., a=..., b=...)` will result in Pubsub Lite messages whose payload has the contents of any_field and whose attribute will be populated with the values of `a` and `b`.")
public abstract @Nullable java.util.List<java.lang.String> getAttributes()

getAttributeId

@SchemaFieldDescription(value="If set, will set an attribute for each Pubsub Lite message with the given name and a unique value. This attribute can then be used in a ReadFromPubSubLite PTransform to deduplicate messages.")
public abstract @Nullable java.lang.String getAttributeId()

getFileDescriptorPath

@SchemaFieldDescription(value="The path to the Protocol Buffer File Descriptor Set file. This file is used for schema definition and message serialization.")
public abstract @Nullable java.lang.String getFileDescriptorPath()

getMessageName

@SchemaFieldDescription(value="The name of the Protocol Buffer message to be used for schema extraction and data conversion.")
public abstract @Nullable java.lang.String getMessageName()

getSchema

public abstract @Nullable java.lang.String getSchema()

builder

public static PubsubLiteWriteSchemaTransformProvider.PubsubLiteWriteSchemaTransformConfiguration.Builder builder()