org.apache.beam.sdk.io.gcp.bigquery

Class StorageApiLoads<DestinationT,ElementT>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<KV<DestinationT,ElementT>>,WriteResult>

org.apache.beam.sdk.io.gcp.bigquery.StorageApiLoads<DestinationT,ElementT>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public class StorageApiLoads<DestinationT,ElementT>
extends PTransform<PCollection<KV<DestinationT,ElementT>>,WriteResult>

This PTransform manages loads into BigQuery using the Storage API.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description

StorageApiLoads(Coder<DestinationT> destinationCoder, org.apache.beam.sdk.io.gcp.bigquery.StorageApiDynamicDestinations<ElementT,DestinationT> dynamicDestinations, SerializableFunction<ElementT,RowMutationInformation> rowUpdateFn, BigQueryIO.Write.CreateDisposition createDisposition, java.lang.String kmsKey, Duration triggeringFrequency, BigQueryServices bqServices, int numShards, boolean allowInconsistentWrites, boolean allowAutosharding, boolean autoUpdateSchema, boolean ignoreUnknownValues, boolean propagateSuccessfulStorageApiWrites, java.util.function.Predicate<java.lang.String> propagateSuccessfulStorageApiWritesPredicate, boolean usesCdc, com.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation defaultMissingValueInterpretation, BadRecordRouter badRecordRouter, ErrorHandler<BadRecord,?> badRecordErrorHandler)

Method Summary

Modifier and Type	Method and Description
WriteResult	expand(PCollection<KV<DestinationT,ElementT>> input) Override this method to specify how this PTransform should be expanded on the given InputT.
WriteResult	expandInconsistent(PCollection<KV<DestinationT,ElementT>> input, Coder<KV<DestinationT,StorageApiWritePayload>> successCoder)
WriteResult	expandTriggered(PCollection<KV<DestinationT,ElementT>> input, Coder<KV<DestinationT,StorageApiWritePayload>> successCoder, Coder<StorageApiWritePayload> payloadCoder)
WriteResult	expandUntriggered(PCollection<KV<DestinationT,ElementT>> input, Coder<KV<DestinationT,StorageApiWritePayload>> successCoder)
TupleTag<BigQueryStorageApiInsertError>	getFailedRowsTag()
boolean	usesErrorHandler()

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageApiLoads

public StorageApiLoads(Coder<DestinationT> destinationCoder,
                       org.apache.beam.sdk.io.gcp.bigquery.StorageApiDynamicDestinations<ElementT,DestinationT> dynamicDestinations,
                       @Nullable
                       SerializableFunction<ElementT,RowMutationInformation> rowUpdateFn,
                       BigQueryIO.Write.CreateDisposition createDisposition,
                       java.lang.String kmsKey,
                       Duration triggeringFrequency,
                       BigQueryServices bqServices,
                       int numShards,
                       boolean allowInconsistentWrites,
                       boolean allowAutosharding,
                       boolean autoUpdateSchema,
                       boolean ignoreUnknownValues,
                       boolean propagateSuccessfulStorageApiWrites,
                       java.util.function.Predicate<java.lang.String> propagateSuccessfulStorageApiWritesPredicate,
                       boolean usesCdc,
                       com.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation defaultMissingValueInterpretation,
                       BadRecordRouter badRecordRouter,
                       ErrorHandler<BadRecord,?> badRecordErrorHandler)

Method Detail

getFailedRowsTag

public TupleTag<BigQueryStorageApiInsertError> getFailedRowsTag()

usesErrorHandler

public boolean usesErrorHandler()

expand

public WriteResult expand(PCollection<KV<DestinationT,ElementT>> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<KV<DestinationT,ElementT>>,WriteResult>

expandInconsistent

public WriteResult expandInconsistent(PCollection<KV<DestinationT,ElementT>> input,
                                      Coder<KV<DestinationT,StorageApiWritePayload>> successCoder)

expandTriggered

public WriteResult expandTriggered(PCollection<KV<DestinationT,ElementT>> input,
                                   Coder<KV<DestinationT,StorageApiWritePayload>> successCoder,
                                   Coder<StorageApiWritePayload> payloadCoder)

expandUntriggered

public WriteResult expandUntriggered(PCollection<KV<DestinationT,ElementT>> input,
                                     Coder<KV<DestinationT,StorageApiWritePayload>> successCoder)