Package io.substrait.relation.physical

Class ImmutableScatterExchange.Builder

java.lang.Object

io.substrait.relation.physical.ImmutableScatterExchange.Builder

Enclosing class:

ImmutableScatterExchange

public static final class ImmutableScatterExchange.Builder
extends Object

Builds instances of type ImmutableScatterExchange. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final ImmutableScatterExchange.Builder	addAllFields(Iterable<? extends FieldReference> elements)	Adds elements to fields list.
final ImmutableScatterExchange.Builder	addAllTargets(Iterable<? extends AbstractExchangeRel.ExchangeTarget> elements)	Adds elements to targets list.
final ImmutableScatterExchange.Builder	addFields(FieldReference element)	Adds one element to fields list.
final ImmutableScatterExchange.Builder	addFields(FieldReference... elements)	Adds elements to fields list.
final ImmutableScatterExchange.Builder	addTargets(AbstractExchangeRel.ExchangeTarget element)	Adds one element to targets list.
final ImmutableScatterExchange.Builder	addTargets(AbstractExchangeRel.ExchangeTarget... elements)	Adds elements to targets list.
ImmutableScatterExchange	build()	Builds a new ImmutableScatterExchange.
final ImmutableScatterExchange.Builder	commonExtension(AdvancedExtension commonExtension)	Initializes the optional value commonExtension to commonExtension.
final ImmutableScatterExchange.Builder	commonExtension(Optional<? extends AdvancedExtension> commonExtension)	Initializes the optional value commonExtension to commonExtension.
final ImmutableScatterExchange.Builder	extension(AdvancedExtension extension)	Initializes the optional value extension to extension.
final ImmutableScatterExchange.Builder	extension(Optional<? extends AdvancedExtension> extension)	Initializes the optional value extension to extension.
final ImmutableScatterExchange.Builder	fields(Iterable<? extends FieldReference> elements)	Sets or replaces all elements for fields list.
final ImmutableScatterExchange.Builder	from(AbstractRel instance)	Fill a builder with attribute values from the provided io.substrait.relation.AbstractRel instance.
final ImmutableScatterExchange.Builder	from(HasExtension instance)	Fill a builder with attribute values from the provided io.substrait.relation.HasExtension instance.
final ImmutableScatterExchange.Builder	from(AbstractExchangeRel instance)	Fill a builder with attribute values from the provided io.substrait.relation.physical.AbstractExchangeRel instance.
final ImmutableScatterExchange.Builder	from(ScatterExchange instance)	Fill a builder with attribute values from the provided io.substrait.relation.physical.ScatterExchange instance.
final ImmutableScatterExchange.Builder	from(Rel instance)	Fill a builder with attribute values from the provided io.substrait.relation.Rel instance.
final ImmutableScatterExchange.Builder	from(SingleInputRel instance)	Fill a builder with attribute values from the provided io.substrait.relation.SingleInputRel instance.
final ImmutableScatterExchange.Builder	hint(Hint hint)	Initializes the optional value hint to hint.
final ImmutableScatterExchange.Builder	hint(Optional<? extends Hint> hint)	Initializes the optional value hint to hint.
final ImmutableScatterExchange.Builder	input(Rel input)	Initializes the value for the input attribute.
final ImmutableScatterExchange.Builder	partitionCount(Integer partitionCount)	Initializes the value for the partitionCount attribute.
final ImmutableScatterExchange.Builder	remap(Rel.Remap remap)	Initializes the optional value remap to remap.
final ImmutableScatterExchange.Builder	remap(Optional<? extends Rel.Remap> remap)	Initializes the optional value remap to remap.
final ImmutableScatterExchange.Builder	targets(Iterable<? extends AbstractExchangeRel.ExchangeTarget> elements)	Sets or replaces all elements for targets list.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableScatterExchange.Builder from(AbstractExchangeRel instance)

Fill a builder with attribute values from the provided io.substrait.relation.physical.AbstractExchangeRel instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableScatterExchange.Builder from(HasExtension instance)

Fill a builder with attribute values from the provided io.substrait.relation.HasExtension instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableScatterExchange.Builder from(ScatterExchange instance)

Fill a builder with attribute values from the provided io.substrait.relation.physical.ScatterExchange instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableScatterExchange.Builder from(Rel instance)

Fill a builder with attribute values from the provided io.substrait.relation.Rel instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableScatterExchange.Builder from(AbstractRel instance)

Fill a builder with attribute values from the provided io.substrait.relation.AbstractRel instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableScatterExchange.Builder from(SingleInputRel instance)

Fill a builder with attribute values from the provided io.substrait.relation.SingleInputRel instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

extension

public final ImmutableScatterExchange.Builder extension(AdvancedExtension extension)

Initializes the optional value extension to extension.

Parameters:

extension - The value for extension

Returns:

this builder for chained invocation

extension

public final ImmutableScatterExchange.Builder extension(Optional<? extends AdvancedExtension> extension)

Initializes the optional value extension to extension.

Parameters:

extension - The value for extension

Returns:

this builder for use in a chained invocation

remap

public final ImmutableScatterExchange.Builder remap(Rel.Remap remap)

Initializes the optional value remap to remap.

Parameters:

remap - The value for remap

Returns:

this builder for chained invocation

remap

public final ImmutableScatterExchange.Builder remap(Optional<? extends Rel.Remap> remap)

Initializes the optional value remap to remap.

Parameters:

remap - The value for remap

Returns:

this builder for use in a chained invocation

commonExtension

public final ImmutableScatterExchange.Builder commonExtension(AdvancedExtension commonExtension)

Initializes the optional value commonExtension to commonExtension.

Parameters:

commonExtension - The value for commonExtension

Returns:

this builder for chained invocation

commonExtension

public final ImmutableScatterExchange.Builder commonExtension(Optional<? extends AdvancedExtension> commonExtension)

Initializes the optional value commonExtension to commonExtension.

Parameters:

commonExtension - The value for commonExtension

Returns:

this builder for use in a chained invocation

hint

public final ImmutableScatterExchange.Builder hint(Hint hint)

Initializes the optional value hint to hint.

Parameters:

hint - The value for hint

Returns:

this builder for chained invocation

hint

public final ImmutableScatterExchange.Builder hint(Optional<? extends Hint> hint)

Initializes the optional value hint to hint.

Parameters:

hint - The value for hint

Returns:

this builder for use in a chained invocation

input

public final ImmutableScatterExchange.Builder input(Rel input)

Initializes the value for the input attribute.

Parameters:

input - The value for input

Returns:

this builder for use in a chained invocation

partitionCount

public final ImmutableScatterExchange.Builder partitionCount(Integer partitionCount)

Initializes the value for the partitionCount attribute.

Parameters:

partitionCount - The value for partitionCount

Returns:

this builder for use in a chained invocation

addTargets

public final ImmutableScatterExchange.Builder addTargets(AbstractExchangeRel.ExchangeTarget element)

Adds one element to targets list.

Parameters:

element - A targets element

Returns:

this builder for use in a chained invocation

addTargets

public final ImmutableScatterExchange.Builder addTargets(AbstractExchangeRel.ExchangeTarget... elements)

Adds elements to targets list.

Parameters:

elements - An array of targets elements

Returns:

this builder for use in a chained invocation

targets

public final ImmutableScatterExchange.Builder targets(Iterable<? extends AbstractExchangeRel.ExchangeTarget> elements)

Sets or replaces all elements for targets list.

Parameters:

elements - An iterable of targets elements

Returns:

this builder for use in a chained invocation

addAllTargets

public final ImmutableScatterExchange.Builder addAllTargets(Iterable<? extends AbstractExchangeRel.ExchangeTarget> elements)

Adds elements to targets list.

Parameters:

elements - An iterable of targets elements

Returns:

this builder for use in a chained invocation

addFields

public final ImmutableScatterExchange.Builder addFields(FieldReference element)

Adds one element to fields list.

Parameters:

element - A fields element

Returns:

this builder for use in a chained invocation

addFields

public final ImmutableScatterExchange.Builder addFields(FieldReference... elements)

Adds elements to fields list.

Parameters:

elements - An array of fields elements

Returns:

this builder for use in a chained invocation

fields

public final ImmutableScatterExchange.Builder fields(Iterable<? extends FieldReference> elements)

Sets or replaces all elements for fields list.

Parameters:

elements - An iterable of fields elements

Returns:

this builder for use in a chained invocation

addAllFields

public final ImmutableScatterExchange.Builder addAllFields(Iterable<? extends FieldReference> elements)

Adds elements to fields list.

Parameters:

elements - An iterable of fields elements

Returns:

this builder for use in a chained invocation

build

public ImmutableScatterExchange build()

Builds a new ImmutableScatterExchange.

Returns:

An immutable instance of ScatterExchange

Throws:

IllegalStateException - if any required attributes are missing