org.apache.beam.sdk.schemas.transforms

Class Group.CombineFieldsByFields<InputT>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<InputT>,PCollection<Row>>

org.apache.beam.sdk.schemas.transforms.Group.AggregateCombiner<InputT>

org.apache.beam.sdk.schemas.transforms.Group.CombineFieldsByFields<InputT>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

Group

public abstract static class Group.CombineFieldsByFields<InputT>
extends Group.AggregateCombiner<InputT>

a PTransform that does a per-key combine using an aggregation built up by calls to aggregateField and aggregateFields. The output of this transform will have a schema that is determined by the output types of all the composed combiners.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.CombineFieldsByFields.Fanout

Field Summary

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

name, resourceHints

Constructor Summary

Constructors

Constructor and Description
CombineFieldsByFields()

Method Summary

Modifier and Type	Method and Description
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateField(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateField(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateField(java.lang.String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateField(java.lang.String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldBaseValue(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldBaseValue(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldBaseValue(java.lang.String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldBaseValue(java.lang.String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFields(FieldAccessDescriptor fieldsToAggregate, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFields(FieldAccessDescriptor fieldsToAggregate, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFields(java.util.List<java.lang.String> inputFieldNames, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFields(java.util.List<java.lang.String> inputFieldNames, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName) Build up an aggregation function over the input elements.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldsById(java.util.List<java.lang.Integer> inputFieldIds, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField) Build up an aggregation function over the input elements by field id.
PCollection<Row>	expand(PCollection<InputT> input) Override this method to specify how this PTransform should be expanded on the given InputT.
Group.CombineFieldsByFields<InputT>	withHotKeyFanout(int n)
Group.CombineFieldsByFields<InputT>	withHotKeyFanout(SerializableFunction<Row,java.lang.Integer> f)
Group.CombineFieldsByFields<InputT>	withKeyField(java.lang.String keyField) Set the name of the key field in the resulting schema.
Group.CombineFieldsByFields<InputT>	withPrecombining(boolean value) Enable precombining.
Group.CombineFieldsByFields<InputT>	witValueField(java.lang.String valueField) Set the name of the value field in the resulting schema.

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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CombineFieldsByFields

public CombineFieldsByFields()

Method Detail

withKeyField

public Group.CombineFieldsByFields<InputT> withKeyField(java.lang.String keyField)

Set the name of the key field in the resulting schema.

witValueField

public Group.CombineFieldsByFields<InputT> witValueField(java.lang.String valueField)

Set the name of the value field in the resulting schema.

withPrecombining

public Group.CombineFieldsByFields<InputT> withPrecombining(boolean value)

Enable precombining.

This is on by default. In certain cases (e.g. if there are many unique field values and the combiner's intermediate state is larger than the average row size) precombining makes things worse, in which case it can be turned off.

withHotKeyFanout

public Group.CombineFieldsByFields<InputT> withHotKeyFanout(int n)

withHotKeyFanout

public Group.CombineFieldsByFields<InputT> withHotKeyFanout(SerializableFunction<Row,java.lang.Integer> f)

aggregateField

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateField(java.lang.String inputFieldName,
                                                                                                Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                java.lang.String outputFieldName)

Build up an aggregation function over the input elements.

This method specifies an aggregation over single field of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

Field types in the output schema will be inferred from the provided combine function. Sometimes the field type cannot be inferred due to Java's type erasure. In that case, use the overload that allows setting the output field type explicitly.

aggregateFieldBaseValue

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFieldBaseValue(java.lang.String inputFieldName,
                                                                                                         Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                         java.lang.String outputFieldName)

aggregateField

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateField(int inputFieldId,
                                                                                                Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                java.lang.String outputFieldName)

aggregateFieldBaseValue

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFieldBaseValue(int inputFieldId,
                                                                                                         Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                         java.lang.String outputFieldName)

aggregateField

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateField(java.lang.String inputFieldName,
                                                                                                Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                Schema.Field outputField)

Build up an aggregation function over the input elements.

This method specifies an aggregation over single field of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

Specified by:

aggregateField in class Group.AggregateCombiner<InputT>

aggregateFieldBaseValue

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFieldBaseValue(java.lang.String inputFieldName,
                                                                                                         Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                         Schema.Field outputField)

aggregateField

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateField(int inputFieldId,
                                                                                                Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                Schema.Field outputField)

Description copied from class: Group.AggregateCombiner

Build up an aggregation function over the input elements.

This method specifies an aggregation over single field of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

Specified by:

aggregateField in class Group.AggregateCombiner<InputT>

aggregateFieldBaseValue

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFieldBaseValue(int inputFieldId,
                                                                                                         Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                         Schema.Field outputField)

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFields(java.util.List<java.lang.String> inputFieldNames,
                                                                                                 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                 java.lang.String outputFieldName)

Build up an aggregation function over the input elements.

This method specifies an aggregation over multiple fields of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

Field types in the output schema will be inferred from the provided combine function. Sometimes the field type cannot be inferred due to Java's type erasure. In that case, use the overload that allows setting the output field type explicitly.

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFields(FieldAccessDescriptor fieldsToAggregate,
                                                                                                 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                 java.lang.String outputFieldName)

Build up an aggregation function over the input elements.

This method specifies an aggregation over multiple fields of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

Field types in the output schema will be inferred from the provided combine function. Sometimes the field type cannot be inferred due to Java's type erasure. In that case, use the overload that allows setting the output field type explicitly.

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFields(java.util.List<java.lang.String> inputFieldNames,
                                                                                                 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                 Schema.Field outputField)

Build up an aggregation function over the input elements.

This method specifies an aggregation over multiple fields of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

aggregateFieldsById

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFieldsById(java.util.List<java.lang.Integer> inputFieldIds,
                                                                                                     Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                     Schema.Field outputField)

Description copied from class: Group.AggregateCombiner

Build up an aggregation function over the input elements by field id.

This method specifies an aggregation over multiple fields of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

Field types in the output schema will be inferred from the provided combine function. Sometimes the field type cannot be inferred due to Java's type erasure. In that case, use the overload that allows setting the output field type explicitly.

Specified by:

aggregateFieldsById in class Group.AggregateCombiner<InputT>

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsByFields<InputT> aggregateFields(FieldAccessDescriptor fieldsToAggregate,
                                                                                                 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                 Schema.Field outputField)

Build up an aggregation function over the input elements.

This method specifies an aggregation over multiple fields of the input. The union of all calls to aggregateField and aggregateFields will determine the output schema.

expand

public PCollection<Row> expand(PCollection<InputT> 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<InputT>,PCollection<Row>>