Package io.substrait.relation

Class ImmutableNamedScan.Builder

java.lang.Object
io.substrait.relation.ImmutableNamedScan.Builder
Enclosing class:
ImmutableNamedScan
public static final class ImmutableNamedScan.Builder extends Object
Builds instances of type ImmutableNamedScan. 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 Details

    • from

      public final ImmutableNamedScan.Builder from(ZeroInputRel instance)
      Fill a builder with attribute values from the provided io.substrait.relation.ZeroInputRel instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      public final ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.Builder from(NamedScan instance)
      Fill a builder with attribute values from the provided io.substrait.relation.NamedScan instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      public final ImmutableNamedScan.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 ImmutableNamedScan.Builder from(AbstractReadRel instance)
      Fill a builder with attribute values from the provided io.substrait.relation.AbstractReadRel instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • extension

      public final ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.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 ImmutableNamedScan.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

    • initialSchema

      public final ImmutableNamedScan.Builder initialSchema(NamedStruct initialSchema)
      Initializes the value for the initialSchema attribute.
      Parameters:
      initialSchema - The value for initialSchema
      Returns:
      this builder for use in a chained invocation

    • filter

      public final ImmutableNamedScan.Builder filter(Expression filter)
      Initializes the optional value filter to filter.
      Parameters:
      filter - The value for filter
      Returns:
      this builder for chained invocation

    • filter

      public final ImmutableNamedScan.Builder filter(Optional<? extends Expression> filter)
      Initializes the optional value filter to filter.
      Parameters:
      filter - The value for filter
      Returns:
      this builder for use in a chained invocation

    • bestEffortFilter

      public final ImmutableNamedScan.Builder bestEffortFilter(Expression bestEffortFilter)
      Initializes the optional value bestEffortFilter to bestEffortFilter.
      Parameters:
      bestEffortFilter - The value for bestEffortFilter
      Returns:
      this builder for chained invocation

    • bestEffortFilter

      public final ImmutableNamedScan.Builder bestEffortFilter(Optional<? extends Expression> bestEffortFilter)
      Initializes the optional value bestEffortFilter to bestEffortFilter.
      Parameters:
      bestEffortFilter - The value for bestEffortFilter
      Returns:
      this builder for use in a chained invocation

    • addNames

      public final ImmutableNamedScan.Builder addNames(String element)
      Adds one element to names list.
      Parameters:
      element - A names element
      Returns:
      this builder for use in a chained invocation

    • addNames

      public final ImmutableNamedScan.Builder addNames(String... elements)
      Adds elements to names list.
      Parameters:
      elements - An array of names elements
      Returns:
      this builder for use in a chained invocation

    • names

      public final ImmutableNamedScan.Builder names(Iterable<String> elements)
      Sets or replaces all elements for names list.
      Parameters:
      elements - An iterable of names elements
      Returns:
      this builder for use in a chained invocation

    • addAllNames

      public final ImmutableNamedScan.Builder addAllNames(Iterable<String> elements)
      Adds elements to names list.
      Parameters:
      elements - An iterable of names elements
      Returns:
      this builder for use in a chained invocation

    • build

      public ImmutableNamedScan build()
      Builds a new ImmutableNamedScan.
      Returns:
      An immutable instance of NamedScan
      Throws:
      IllegalStateException - if any required attributes are missing