Package org.apache.beam.sdk.schemas.transforms

Class Group.ByFields<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.ByFields<InputT>

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

Group

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

a PTransform that groups schema elements based on the given fields.

The output of this transform will have a key field of type Row containing the specified extracted fields. It will also have a value field of type Row containing the specified extracted fields.

See Also:

• Serialized Form

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor	Description
ByFields()

Method Summary

Modifier and Type	Method	Description
<CombineInputT, AccumT, CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateField(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)
<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(String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)	Build up an aggregation function over the input elements.
<CombineInputT, AccumT, CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateField(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>	aggregateFieldBaseValue(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)
<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(String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)
<CombineInputT, AccumT, CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldBaseValue(String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField)
<CombineInputT, AccumT, CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFields(List<String> inputFieldNames, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)	Build up an aggregation function over the input elements.
<CombineInputT, AccumT, CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFields(List<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(FieldAccessDescriptor fieldsToAggregate, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)	Build up an aggregation function over the input elements.
<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>	aggregateFieldsById(List<Integer> inputFieldIds, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, String outputFieldName)
<CombineInputT, AccumT, CombineOutputT> Group.CombineFieldsByFields<InputT>	aggregateFieldsById(List<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.ByFields<InputT>.org.apache.beam.sdk.schemas.transforms.Group.ByFields.ToKV	getToKV()
Group.ByFields<InputT>	withKeyField(String keyField)
Group.ByFields<InputT>	withValueField(String valueField)

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 Details

ByFields

public ByFields()

Method Details

getToKV

public Group.ByFields<InputT>.org.apache.beam.sdk.schemas.transforms.Group.ByFields.ToKV getToKV()

withKeyField

public Group.ByFields<InputT> withKeyField(String keyField)

withValueField

public Group.ByFields<InputT> withValueField(String valueField)

aggregateField

public <CombineInputT,
AccumT,
CombineOutputT>
Group.CombineFieldsByFields<InputT> aggregateField(String inputFieldName,
 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
 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(String inputFieldName,
 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
 String outputFieldName)

aggregateField

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

aggregateFieldBaseValue

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

aggregateField

public <CombineInputT,
AccumT,
CombineOutputT>
Group.CombineFieldsByFields<InputT> aggregateField(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(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(List<String> inputFieldNames,
 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
 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.

aggregateFieldsById

public <CombineInputT,
AccumT,
CombineOutputT>
Group.CombineFieldsByFields<InputT> aggregateFieldsById(List<Integer> inputFieldIds,
 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
 String outputFieldName)

aggregateFields

public <CombineInputT,
AccumT,
CombineOutputT>
Group.CombineFieldsByFields<InputT> aggregateFields(FieldAccessDescriptor fieldsToAggregate,
 Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
 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(List<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(List<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>>