All Classes

Class	Description
ApproximateQuantilesExample
AutoComplete	An example that computes the most popular hash tags for every prefix, which can be used for auto-completion.
AutoComplete.ComputeTopCompletions	A PTransform that takes as input a list of tokens and returns the most common tokens per prefix.
AutoComplete.Options	Options supported by this class.
AvroDataClass	Example of AVRO serialization class.
AvroDataClassKafkaAvroDeserializer	Example of custom AVRO Deserialize.
BigQueryTornadoes	An example that reads the public samples of weather data from BigQuery, counts the number of tornadoes that occur in each month, and writes the results to BigQuery.
BigQueryTornadoes.Options	Options supported by BigQueryTornadoes.
CallingSubProcessUtils	Utility class for dealing with concurrency and binary file copies to the worker.
CallingSubProcessUtils.Permit	Permit class for access to worker cpu resources.
CoGroupByKeyExample
CombineExample
CombinePerKeyExamples	An example that reads the public 'Shakespeare' data, and for each word in the dataset that is over a given length, generates a string containing the list of play names in which that word appears, and saves this information to a bigquery table.
CombinePerKeyExamples.ConcatWords	A 'combine function' used with the Combine.perKey transform.
CombinePerKeyExamples.Options	Options supported by CombinePerKeyExamples.
CountExample
CountPerKeyExample
CreateExample
CsvConverters	Common transforms for Csv files.
CsvConverters.CsvPipelineOptions	Necessary PipelineOptions options for Csv Pipelines.
CsvConverters.DelimiterFactory	Default value factory to get delimiter from Csv format so that if the user does not pass one in, it matches the supplied CsvConverters.CsvPipelineOptions.getCsvFormat().
CsvConverters.FailsafeElementToJsonFn	The CsvConverters.FailsafeElementToJsonFn class creates a Json string from a failsafe element.
CsvConverters.LineToFailsafeJson	The CsvConverters.LineToFailsafeJson interface converts a line from a Csv file into a Json string.
CsvConverters.LineToFailsafeJson.Builder	Builder for CsvConverters.LineToFailsafeJson.
CsvConverters.ReadCsv	The CsvConverters.ReadCsv class is a PTransform that reads from one for more Csv files.
CsvConverters.ReadCsv.Builder	Builder for CsvConverters.ReadCsv.
DataProtectors	The DataProtectors Using passing parameters transform will buffer input rows in batch and will send it when the count of buffered rows will equal specified batch size.
DataProtectors.RowToTokenizedRow<T>	The DataProtectors.RowToTokenizedRow transform converts Row to TableRow objects.
DataProtectors.RowToTokenizedRow.Builder<T>	Builder for DataProtectors.RowToTokenizedRow.
DataProtectors.TokenizationFn	Class implements stateful doFn for data tokenization using remote RPC.
DataTokenization	The DataTokenization pipeline reads data from one of the supported sources, tokenizes data with external API calls to some tokenization server, and writes data into one of the supported sinks.
DataTokenizationOptions	The DataTokenizationOptions interface provides the custom execution options passed by the executor at the command-line.
DebuggingWordCount	An example that verifies word counts in Shakespeare and includes Beam best practices.
DebuggingWordCount.FilterTextFn	A DoFn that filters for a specific key based upon a regular expression.
DebuggingWordCount.WordCountOptions	Options supported by DebuggingWordCount.
DistinctExample	This example uses as input text of King Lear, by William Shakespeare as plaintext files, and will remove any duplicate lines from this file.
DistinctExample
DistinctExample.Options	Options supported by DistinctExample.
DistinctExample.Options.OutputFactory	Returns gs://${TEMP_LOCATION}/"deduped.txt".
DurationUtils	The DurationUtils class provides common utilities for manipulating and formatting Duration objects.
ErrorConverters	Transforms & DoFns & Options for Teleport Error logging.
ErrorConverters.FailedStringToCsvRowFn	The ErrorConverters.FailedStringToCsvRowFn converts string objects which have failed processing into String objects contained CSV which can be output to a filesystem.
ErrorConverters.FailedStringToTableRowFn	The ErrorConverters.FailedStringToTableRowFn converts string objects which have failed processing into TableRow objects which can be output to a dead-letter table.
ErrorConverters.WriteErrorsToTextIO<T,V>	ErrorConverters.WriteErrorsToTextIO is a PTransform that writes strings error messages to file system using TextIO and custom line format SerializableFunction to convert errors in necessary format.
ErrorConverters.WriteErrorsToTextIO.Builder<T,V>	Builder for ErrorConverters.WriteErrorsToTextIO.
ErrorConverters.WriteStringMessageErrors	Write errors as string encoded messages.
ErrorConverters.WriteStringMessageErrors.Builder	Builder for ErrorConverters.WriteStringMessageErrors.
ErrorConverters.WriteStringMessageErrorsAsCsv	Writes all Errors to GCS, place at the end of your pipeline.
ErrorConverters.WriteStringMessageErrorsAsCsv.Builder	Builder for ErrorConverters.WriteStringMessageErrorsAsCsv.
ExampleBigQueryTableOptions	Options that can be used to configure BigQuery tables in Beam examples.
ExampleBigQueryTableOptions.BigQueryTableFactory	Returns the job name as the default BigQuery table name.
ExampleEchoPipeline	Please see the Readme.MD file for instructions to execute this pipeline.
ExampleEchoPipeline.EchoInputDoFn	Simple DoFn that echos the element, used as an example of running a C++ library.
ExampleOptions	Options that can be used to configure the Beam examples.
ExamplePubsubTopicAndSubscriptionOptions	Options that can be used to configure Pub/Sub topic/subscription in Beam examples.
ExamplePubsubTopicAndSubscriptionOptions.PubsubSubscriptionFactory	Returns a default Pub/Sub subscription based on the project and the job names.
ExamplePubsubTopicOptions	Options that can be used to configure Pub/Sub topic in Beam examples.
ExamplePubsubTopicOptions.PubsubTopicFactory	Returns a default Pub/Sub topic based on the project and the job names.
ExampleUtils	The utility class that sets up and tears down external resources, and cancels the streaming pipelines once the program terminates.
ExecutableFile	Contains the configuration for the external library.
FailsafeElement<OriginalT,CurrentT>	The FailsafeElement class holds the current value and original value of a record within a pipeline.
FailsafeElementCoder<OriginalT,CurrentT>	The FailsafeElementCoder encodes and decodes FailsafeElement objects.
FileUtils	Utilities for dealing with movement of files from object stores and workers.
FilterExamples	This is an example that demonstrates several approaches to filtering, and use of the Mean transform.
FilterExamples.Options	Options supported by FilterExamples.
FlatMapElementsExample
FormatTransform	Different transformations over the processed data in the pipeline.
FormatTransform.FORMAT
FormatTransform.FormatOutput	The FormatTransform.FormatOutput wraps a String serializable messages with the PubsubMessage class.
GameConstants	Shared constants between game series classes.
GameStats	This class is the fourth in a series of four pipelines that tell a story in a 'gaming' domain, following UserScore, HourlyTeamScore, and LeaderBoard.
GameStats.CalculateSpammyUsers	Filter out all users but those with a high clickrate, which we will consider as 'spammy' users.
GameStats.Options	Options supported by GameStats.
GroupIntoBatchesExample
HourlyTeamScore	This class is the second in a series of four pipelines that tell a story in a 'gaming' domain, following UserScore.
HourlyTeamScore.Options	Options supported by HourlyTeamScore.
IcebergTaxiExamples	Reads real-time NYC taxi ride information from projects/pubsub-public-data/topics/taxirides-realtime and writes to Iceberg tables using Beam's Managed IcebergIO sink.
IcebergTaxiExamples.IcebergPipelineOptions
JoinExamples	This example shows how to do a join on two collections.
JoinExamples.Options	Options supported by JoinExamples.
JsonToBeamRow	The JsonToBeamRow converts jsons string to beam rows.
KafkaPassengerCountJson
KafkaPassengerCountJson.KafkaStreamingOptions
KafkaPubsubConstants	Constant variables that are used across the template's parts.
KafkaStreaming
KafkaStreaming.IntermittentlyFailingIntegerDeserializer
KafkaStreaming.KafkaConsumer
KafkaStreaming.KafkaProducer
KafkaStreaming.KafkaStreamingOptions
KafkaToPubsub	The KafkaToPubsub pipeline is a streaming pipeline which ingests data in JSON format from Kafka, and outputs the resulting records to PubSub.
KafkaToPubsubOptions
KafkaWordCountAvro
KafkaWordCountAvro.KafkaStreamingOptions
KafkaWordCountJson
KafkaWordCountJson.KafkaStreamingOptions
KeysExample
KvSwapExample
LatestExample
LeaderBoard	This class is the third in a series of four pipelines that tell a story in a 'gaming' domain, following UserScore and HourlyTeamScore.
LeaderBoard.Options	Options supported by LeaderBoard.
MapElementsExample
MaxExample
MaxPerKeyExample
MaxPerKeyExamples	An example that reads the public samples of weather data from BigQuery, and finds the maximum temperature ('mean_temp') for each month.
MaxPerKeyExamples.Options	Options supported by MaxPerKeyExamples.
MeanExample
MeanPerKeyExample
MinExample
MinimalBigQueryTornadoes	An example that reads the public samples of weather data from BigQuery, counts the number of tornadoes that occur in each month, and writes the results to BigQuery.
MinimalWordCount	An example that counts words in Shakespeare.
MinPerKeyExample
PartitionExample
PythonDataframeWordCount	An example that counts words in Shakespeare and utilizes a Python external transform.
PythonDataframeWordCount.FormatAsTextFn	A SimpleFunction that converts a counted row into a printable string.
PythonDataframeWordCount.WordCountOptions	Options supported by PythonDataframeWordCount.
RegexExample
RetryHttpInitializerWrapper	RetryHttpInitializerWrapper will automatically retry upon RPC failures, preserving the auto-refresh behavior of the Google Credentials.
RowToCsv	The RowToCsv class to convert Beam Rows into strings in CSV format.
SampleExample
SchemasUtils	The SchemasUtils Class to read JSON based schema.
SerializableFunctions	The SerializableFunctions class to store static Serializable functions.
SklearnMnistClassification	An example Java Multi-language pipeline that Performs image classification on handwritten digits from the MNIST database.
SklearnMnistClassification.SklearnMnistClassificationOptions
Snippets	Code snippets used in webdocs.
Snippets.CustomSessionPipeline
Snippets.DeadLetterBigQuery
Snippets.DynamicSessions
Snippets.MyOptions	Sample of PipelineOptions with a ValueProvider option argument.
Snippets.NaturalLanguageIntegration
Snippets.PeriodicallyUpdatingSideInputs
Snippets.PlaceholderExternalService	Placeholder class that represents an external service generating test data.
Snippets.SchemaJoinPattern
SslConsumerFactoryFn	Class to create Kafka Consumer with configured SSL.
StatefulTeamScore	This class is part of a series of pipelines that tell a story in a gaming domain.
StatefulTeamScore.Options	Options supported by StatefulTeamScore.
StatefulTeamScore.UpdateTeamScoreFn	Tracks each team's score separately in a single state cell and outputs the score every time it passes a new multiple of a threshold.
StreamingWordExtract	A streaming Beam Example using BigQuery output.
StreamingWordExtract.StreamingWordExtractOptions	Options supported by StreamingWordExtract.
SubProcessCommandLineArgs	Parameters to the sub-process, has tuple of ordinal position and the value.
SubProcessCommandLineArgs.Command	Class used to store the SubProcces parameters.
SubProcessConfiguration	Configuration file used to setup the Process kernel for execution of the external library Values are copied from the Options to all them to be Serializable.
SubProcessIOFiles	All information generated from the process will be stored in output files.
SubProcessKernel	This is the process kernel which deals with exec of the subprocess.
SubProcessPipelineOptions	Options for running a sub process within a DoFn.
SubProcessPipelineOptions.SubProcessConfigurationFactory	Confirm Configuration and return a configuration object used in pipeline.
SumExample
SumPerKeyExample
TfIdf	An example that computes a basic TF-IDF search table for a directory or GCS prefix.
TfIdf.ComputeTfIdf	A transform containing a basic TF-IDF pipeline.
TfIdf.Options	Options supported by TfIdf.
TfIdf.ReadDocuments	Reads the documents at the provided uris and returns all lines from the documents tagged with which document they are from.
TfIdf.WriteTfIdf	A PTransform to write, in CSV format, a mapping from term and URI to score.
TokenizationBigQueryIO	The TokenizationBigQueryIO class for writing data from template to BigTable.
TokenizationBigQueryIO.RowToTableRowFn	The TokenizationBigQueryIO.RowToTableRowFn class converts a row to tableRow using BigQueryUtils.toTableRow().
TokenizationBigTableIO	The TokenizationBigTableIO class for writing data from template to BigTable.
TokenizationBigTableIO.BigTableOptions	Necessary PipelineOptions options for Pipelines that perform write operations to BigTable.
TokenizationFileSystemIO	The TokenizationFileSystemIO class to read/write data from/into File Systems.
TokenizationFileSystemIO.FileSystemPipelineOptions	Necessary PipelineOptions options for Pipelines that operate with JSON/CSV data in FS.
TokenizationFileSystemIO.FORMAT	Supported format to read from GCS.
TopExample
TopWikipediaSessions	An example that reads Wikipedia edit data from Cloud Storage and computes the user with the longest string of edits separated by no more than an hour within each month.
TopWikipediaSessions.Options	Options supported by this class.
ToStringExample
TrafficMaxLaneFlow	A Beam Example that runs in both batch and streaming modes with traffic sensor data.
TrafficMaxLaneFlow.MaxFlow	A custom 'combine function' used with the Combine.perKey transform.
TrafficMaxLaneFlow.TrafficMaxLaneFlowOptions	Options supported by TrafficMaxLaneFlow.
TrafficRoutes	A Beam Example that runs in both batch and streaming modes with traffic sensor data.
TrafficRoutes.TrafficRoutesOptions	Options supported by TrafficRoutes.
TriggerExample	This example illustrates the basic concepts behind triggering.
TriggerExample.InsertDelays	Add current time to each record.
TriggerExample.TrafficFlowOptions	Inherits standard configuration options.
UserScore	This class is the first in a series of four pipelines that tell a story in a 'gaming' domain.
UserScore.ExtractAndSumScore	A transform to extract key/score information from GameActionInfo, and sum the scores.
UserScore.Options	Options supported by UserScore.
Utils	Utilities for construction of Kafka Consumer.
ValuesExample
ViewExample
WindowedWordCount	An example that counts words in text, and can run over either unbounded or bounded input collections.
WindowedWordCount.DefaultToCurrentSystemTime	A DefaultValueFactory that returns the current system time.
WindowedWordCount.DefaultToMinTimestampPlusOneHour	A DefaultValueFactory that returns the minimum timestamp plus one hour.
WindowedWordCount.Options	Options for WindowedWordCount.
WindowExample
WordCount	An example that counts words in Shakespeare and includes Beam best practices.
WordCount.CountWords	A PTransform that converts a PCollection containing lines of text into a PCollection of formatted word counts.
WordCount.FormatAsTextFn	A SimpleFunction that converts a Word and Count into a printable string.
WordCount.WordCountOptions	Options supported by WordCount.
WriteOneFilePerWindow	A DoFn that writes elements to files with names deterministically derived from the lower and upper bounds of their key (an IntervalWindow).
WriteOneFilePerWindow.PerWindowFiles	A FileBasedSink.FilenamePolicy produces a base file name for a write based on metadata about the data being written.
WriteToBigQuery<InputT>	Generate, format, and write BigQuery table row information.
WriteToBigQuery.FieldFn<InputT>	A Serializable function from a DoFn.ProcessContext and BoundedWindow to the value for that field.
WriteToBigQuery.FieldInfo<InputT>	Define a class to hold information about output table field definitions.
WriteToText<InputT>	Generate, format, and write rows.
WriteToText.FieldFn<InputT>	A Serializable function from a DoFn.ProcessContext and BoundedWindow to the value for that field.
WriteToText.PerWindowFiles	A FileBasedSink.FilenamePolicy produces a base file name for a write based on metadata about the data being written.
WriteToText.WriteOneFilePerWindow	A DoFn that writes elements to files with names deterministically derived from the lower and upper bounds of their key (an IntervalWindow).
WriteWindowedToBigQuery<T>	Generate, format, and write BigQuery table row information.