org.apache.beam.sdk.schemas.transforms

Class Group.Global<InputT>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<InputT>,PCollection<java.lang.Iterable<InputT>>>

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

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

Group

public static class Group.Global<InputT>
extends PTransform<PCollection<InputT>,PCollection<java.lang.Iterable<InputT>>>

A PTransform for doing global aggregations on schema PCollections.

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
Global()

Method Summary

Modifier and Type	Method and Description
<OutputT> Group.CombineGlobally<InputT,OutputT>	aggregate(Combine.CombineFn<InputT,?,OutputT> combineFn) Aggregate the grouped data using the specified Combine.CombineFn.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<InputT>	aggregateField(int inputFielId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField) The same as aggregateField(java.lang.String, org.apache.beam.sdk.transforms.Combine.CombineFn<CombineInputT, AccumT, CombineOutputT>, java.lang.String) but using field id.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<InputT>	aggregateField(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName) The same as aggregateField(java.lang.String, org.apache.beam.sdk.transforms.Combine.CombineFn<CombineInputT, AccumT, CombineOutputT>, java.lang.String) but using field id.
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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.CombineFieldsGlobally<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.CombineFieldsGlobally<InputT>	aggregateFieldBaseValue(int inputFielId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<InputT>	aggregateFieldBaseValue(int inputFieldId, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<InputT>	aggregateFieldBaseValue(java.lang.String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<InputT>	aggregateFieldBaseValue(java.lang.String inputFieldName, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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.CombineFieldsGlobally<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.CombineFieldsGlobally<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.CombineFieldsGlobally<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.CombineFieldsGlobally<InputT>	aggregateFieldsById(java.util.List<java.lang.Integer> inputFieldIds, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, Schema.Field outputField)
<CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<InputT>	aggregateFieldsById(java.util.List<java.lang.Integer> inputFieldIds, Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn, java.lang.String outputFieldName) The same as aggregateFields(java.util.List<java.lang.String>, org.apache.beam.sdk.transforms.Combine.CombineFn<CombineInputT, AccumT, CombineOutputT>, java.lang.String) but with field ids.
PCollection<java.lang.Iterable<InputT>>	expand(PCollection<InputT> input) Override this method to specify how this PTransform should be expanded on the given InputT.

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

Global

public Global()

Method Detail

aggregate

public <OutputT> Group.CombineGlobally<InputT,OutputT> aggregate(Combine.CombineFn<InputT,?,OutputT> combineFn)

Aggregate the grouped data using the specified Combine.CombineFn. The resulting PCollection will have type OutputT.

aggregateField

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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.

aggregateFieldBaseValue

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

aggregateField

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

The same as aggregateField(java.lang.String, org.apache.beam.sdk.transforms.Combine.CombineFn<CombineInputT, AccumT, CombineOutputT>, java.lang.String) but using field id.

aggregateFieldBaseValue

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

aggregateField

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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.

aggregateFieldBaseValue

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

aggregateField

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

The same as aggregateField(java.lang.String, org.apache.beam.sdk.transforms.Combine.CombineFn<CombineInputT, AccumT, CombineOutputT>, java.lang.String) but using field id.

aggregateFieldBaseValue

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

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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.

aggregateFieldsById

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

The same as aggregateFields(java.util.List<java.lang.String>, org.apache.beam.sdk.transforms.Combine.CombineFn<CombineInputT, AccumT, CombineOutputT>, java.lang.String) but with field ids.

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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.CombineFieldsGlobally<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.CombineFieldsGlobally<InputT> aggregateFieldsById(java.util.List<java.lang.Integer> inputFieldIds,
                                                                                                     Combine.CombineFn<CombineInputT,AccumT,CombineOutputT> fn,
                                                                                                     Schema.Field outputField)

aggregateFields

public <CombineInputT,AccumT,CombineOutputT> Group.CombineFieldsGlobally<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<java.lang.Iterable<InputT>> 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<java.lang.Iterable<InputT>>>