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

Class WriteResult

java.lang.Object

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

All Implemented Interfaces:

POutput

public final class WriteResult
extends java.lang.Object
implements POutput

The result of a BigQueryIO.Write transform.

Method Summary

Modifier and Type	Method and Description
java.util.Map<TupleTag<?>,PValue>	expand() Expands this POutput into a list of its component output PValues.
void	finishSpecifyingOutput(java.lang.String transformName, PInput input, PTransform<?,?> transform) As part of applying the producing PTransform, finalizes this output to make it ready for being used as an input and for running.
PCollection<TableRow>	getFailedInserts() Returns a PCollection containing the TableRows that didn't made it to BQ.
PCollection<BigQueryInsertError>	getFailedInsertsWithErr() Returns a PCollection containing the BigQueryInsertErrors with detailed error information.
Pipeline	getPipeline() Returns the owning Pipeline of this POutput.
PCollection<TableRow>	getSuccessfulInserts() Returns a PCollection containing the TableRows that were written to BQ.

Methods inherited from class java.lang.Object

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

Method Detail

expand

public java.util.Map<TupleTag<?>,PValue> expand()

Description copied from interface: POutput

Expands this POutput into a list of its component output PValues.

• A PValue expands to itself.
• A tuple or list of PValues (such as PCollectionTuple or PCollectionList) expands to its component PValue PValues.

Not intended to be invoked directly by user code.

Specified by:

expand in interface POutput

getFailedInserts

public PCollection<TableRow> getFailedInserts()

Returns a PCollection containing the TableRows that didn't made it to BQ.

Only use this method if you haven't enabled BigQueryIO.Write.withExtendedErrorInfo(). Otherwise use getFailedInsertsWithErr()

getSuccessfulInserts

public PCollection<TableRow> getSuccessfulInserts()

Returns a PCollection containing the TableRows that were written to BQ.

getFailedInsertsWithErr

public PCollection<BigQueryInsertError> getFailedInsertsWithErr()

Returns a PCollection containing the BigQueryInsertErrors with detailed error information.

Only use this method if you have enabled BigQueryIO.Write.withExtendedErrorInfo(). * Otherwise use getFailedInserts()

getPipeline

public Pipeline getPipeline()

Description copied from interface: POutput

Returns the owning Pipeline of this POutput.

Specified by:

getPipeline in interface POutput

finishSpecifyingOutput

public void finishSpecifyingOutput(java.lang.String transformName,
                                   PInput input,
                                   PTransform<?,?> transform)

Description copied from interface: POutput

As part of applying the producing PTransform, finalizes this output to make it ready for being used as an input and for running.

This includes ensuring that all PCollections have Coders specified or defaulted.

Automatically invoked whenever this POutput is output, after POutput.finishSpecifyingOutput(String, PInput, PTransform) has been called on each component PValue returned by POutput.expand().

Specified by:

finishSpecifyingOutput in interface POutput