org.apache.beam.sdk.schemas.transforms

Class CoGroup.By

java.lang.Object

org.apache.beam.sdk.schemas.transforms.CoGroup.By

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

CoGroup

public abstract static class CoGroup.By
extends java.lang.Object
implements java.io.Serializable

Defines the set of fields to extract for the join key, as well as other per-input join options.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
By()

Method Summary

Modifier and Type	Method and Description
static CoGroup.By	fieldAccessDescriptor(FieldAccessDescriptor fieldAccessDescriptor) Join by the following field access descriptor.
static CoGroup.By	fieldIds(java.lang.Integer... fieldIds) Join by the following field ids.
static CoGroup.By	fieldNames(java.lang.String... fieldNames) Join by the following field names.
CoGroup.By	withOptionalParticipation() Means that this field will participate in a join even when not present, similar to SQL outer-join semantics.
CoGroup.By	withSideInput()

Methods inherited from class java.lang.Object

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

Constructor Detail

By

public By()

Method Detail

fieldNames

public static CoGroup.By fieldNames(java.lang.String... fieldNames)

Join by the following field names.

fieldIds

public static CoGroup.By fieldIds(java.lang.Integer... fieldIds)

Join by the following field ids.

fieldAccessDescriptor

public static CoGroup.By fieldAccessDescriptor(FieldAccessDescriptor fieldAccessDescriptor)

Join by the following field access descriptor.

withOptionalParticipation

public CoGroup.By withOptionalParticipation()

Means that this field will participate in a join even when not present, similar to SQL outer-join semantics. Missing entries will be replaced by nulls.

This only affects the results of expandCrossProduct.

withSideInput

public CoGroup.By withSideInput()