Package io.substrait.proto

Interface PlanOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Plan, Plan.Builder
public interface PlanOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasVersion

      boolean hasVersion()
       Substrait version of the plan. Optional up to 0.17.0, required for later
 versions.
      .substrait.Version version = 6;
      Returns:
      Whether the version field is set.

    • getVersion

      Version getVersion()
       Substrait version of the plan. Optional up to 0.17.0, required for later
 versions.
      .substrait.Version version = 6;
      Returns:
      The version.

    • getVersionOrBuilder

      VersionOrBuilder getVersionOrBuilder()
       Substrait version of the plan. Optional up to 0.17.0, required for later
 versions.
      .substrait.Version version = 6;

    • getExtensionUrnsList

      List<SimpleExtensionURN> getExtensionUrnsList()
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;

    • getExtensionUrns

      SimpleExtensionURN getExtensionUrns(int index)
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;

    • getExtensionUrnsCount

      int getExtensionUrnsCount()
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;

    • getExtensionUrnsOrBuilderList

      List<? extends SimpleExtensionURNOrBuilder> getExtensionUrnsOrBuilderList()
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;

    • getExtensionUrnsOrBuilder

      SimpleExtensionURNOrBuilder getExtensionUrnsOrBuilder(int index)
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;

    • getExtensionsList

      List<SimpleExtensionDeclaration> getExtensionsList()
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;

    • getExtensions

      SimpleExtensionDeclaration getExtensions(int index)
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;

    • getExtensionsCount

      int getExtensionsCount()
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;

    • getExtensionsOrBuilderList

      List<? extends SimpleExtensionDeclarationOrBuilder> getExtensionsOrBuilderList()
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;

    • getExtensionsOrBuilder

      SimpleExtensionDeclarationOrBuilder getExtensionsOrBuilder(int index)
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;

    • getRelationsList

      List<PlanRel> getRelationsList()
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;

    • getRelations

      PlanRel getRelations(int index)
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;

    • getRelationsCount

      int getRelationsCount()
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;

    • getRelationsOrBuilderList

      List<? extends PlanRelOrBuilder> getRelationsOrBuilderList()
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;

    • getRelationsOrBuilder

      PlanRelOrBuilder getRelationsOrBuilder(int index)
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;

    • hasAdvancedExtensions

      boolean hasAdvancedExtensions()
       additional extensions associated with this plan.
      .substrait.extensions.AdvancedExtension advanced_extensions = 4;
      Returns:
      Whether the advancedExtensions field is set.

    • getAdvancedExtensions

      AdvancedExtension getAdvancedExtensions()
       additional extensions associated with this plan.
      .substrait.extensions.AdvancedExtension advanced_extensions = 4;
      Returns:
      The advancedExtensions.

    • getAdvancedExtensionsOrBuilder

      AdvancedExtensionOrBuilder getAdvancedExtensionsOrBuilder()
       additional extensions associated with this plan.
      .substrait.extensions.AdvancedExtension advanced_extensions = 4;

    • getExpectedTypeUrlsList

      List<String> getExpectedTypeUrlsList()
       A list of com.google.Any entities that this plan may use. Can be used to
 warn if some embedded message types are unknown. Note that this list may
 include message types that are ignorable (optimizations) or that are
 unused. In many cases, a consumer may be able to work with a plan even if
 one or more message types defined here are unknown.
      repeated string expected_type_urls = 5;
      Returns:
      A list containing the expectedTypeUrls.

    • getExpectedTypeUrlsCount

      int getExpectedTypeUrlsCount()
       A list of com.google.Any entities that this plan may use. Can be used to
 warn if some embedded message types are unknown. Note that this list may
 include message types that are ignorable (optimizations) or that are
 unused. In many cases, a consumer may be able to work with a plan even if
 one or more message types defined here are unknown.
      repeated string expected_type_urls = 5;
      Returns:
      The count of expectedTypeUrls.

    • getExpectedTypeUrls

      String getExpectedTypeUrls(int index)
       A list of com.google.Any entities that this plan may use. Can be used to
 warn if some embedded message types are unknown. Note that this list may
 include message types that are ignorable (optimizations) or that are
 unused. In many cases, a consumer may be able to work with a plan even if
 one or more message types defined here are unknown.
      repeated string expected_type_urls = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The expectedTypeUrls at the given index.

    • getExpectedTypeUrlsBytes

      com.google.protobuf.ByteString getExpectedTypeUrlsBytes(int index)
       A list of com.google.Any entities that this plan may use. Can be used to
 warn if some embedded message types are unknown. Note that this list may
 include message types that are ignorable (optimizations) or that are
 unused. In many cases, a consumer may be able to work with a plan even if
 one or more message types defined here are unknown.
      repeated string expected_type_urls = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the expectedTypeUrls at the given index.

    • getParameterBindingsList

      List<DynamicParameterBinding> getParameterBindingsList()
       An optional list of bindings for dynamic parameters used in this plan.
 Each binding maps a parameter_anchor to its corresponding runtime value.
      repeated .substrait.DynamicParameterBinding parameter_bindings = 7;

    • getParameterBindings

      DynamicParameterBinding getParameterBindings(int index)
       An optional list of bindings for dynamic parameters used in this plan.
 Each binding maps a parameter_anchor to its corresponding runtime value.
      repeated .substrait.DynamicParameterBinding parameter_bindings = 7;

    • getParameterBindingsCount

      int getParameterBindingsCount()
       An optional list of bindings for dynamic parameters used in this plan.
 Each binding maps a parameter_anchor to its corresponding runtime value.
      repeated .substrait.DynamicParameterBinding parameter_bindings = 7;

    • getParameterBindingsOrBuilderList

      List<? extends DynamicParameterBindingOrBuilder> getParameterBindingsOrBuilderList()
       An optional list of bindings for dynamic parameters used in this plan.
 Each binding maps a parameter_anchor to its corresponding runtime value.
      repeated .substrait.DynamicParameterBinding parameter_bindings = 7;

    • getParameterBindingsOrBuilder

      DynamicParameterBindingOrBuilder getParameterBindingsOrBuilder(int index)
       An optional list of bindings for dynamic parameters used in this plan.
 Each binding maps a parameter_anchor to its corresponding runtime value.
      repeated .substrait.DynamicParameterBinding parameter_bindings = 7;

    • getTypeAliasesList

      List<TypeAlias> getTypeAliasesList()
       An optional list of type aliases. Types can be specified here once, and
 then referenced within the plan using the TypeAliasReference type. This
 feature is intended to assist with the usability of parameterized types,
 which require that all parameters be specified when they are declared.
 This can bloat plans with redundant redeclarations, especially if the
 parameterized types being declared have many parameters (e.g., struct with
 many fields, nested parameterized types, string as a type parameter).
      repeated .substrait.TypeAlias type_aliases = 9;

    • getTypeAliases

      TypeAlias getTypeAliases(int index)
       An optional list of type aliases. Types can be specified here once, and
 then referenced within the plan using the TypeAliasReference type. This
 feature is intended to assist with the usability of parameterized types,
 which require that all parameters be specified when they are declared.
 This can bloat plans with redundant redeclarations, especially if the
 parameterized types being declared have many parameters (e.g., struct with
 many fields, nested parameterized types, string as a type parameter).
      repeated .substrait.TypeAlias type_aliases = 9;

    • getTypeAliasesCount

      int getTypeAliasesCount()
       An optional list of type aliases. Types can be specified here once, and
 then referenced within the plan using the TypeAliasReference type. This
 feature is intended to assist with the usability of parameterized types,
 which require that all parameters be specified when they are declared.
 This can bloat plans with redundant redeclarations, especially if the
 parameterized types being declared have many parameters (e.g., struct with
 many fields, nested parameterized types, string as a type parameter).
      repeated .substrait.TypeAlias type_aliases = 9;

    • getTypeAliasesOrBuilderList

      List<? extends TypeAliasOrBuilder> getTypeAliasesOrBuilderList()
       An optional list of type aliases. Types can be specified here once, and
 then referenced within the plan using the TypeAliasReference type. This
 feature is intended to assist with the usability of parameterized types,
 which require that all parameters be specified when they are declared.
 This can bloat plans with redundant redeclarations, especially if the
 parameterized types being declared have many parameters (e.g., struct with
 many fields, nested parameterized types, string as a type parameter).
      repeated .substrait.TypeAlias type_aliases = 9;

    • getTypeAliasesOrBuilder

      TypeAliasOrBuilder getTypeAliasesOrBuilder(int index)
       An optional list of type aliases. Types can be specified here once, and
 then referenced within the plan using the TypeAliasReference type. This
 feature is intended to assist with the usability of parameterized types,
 which require that all parameters be specified when they are declared.
 This can bloat plans with redundant redeclarations, especially if the
 parameterized types being declared have many parameters (e.g., struct with
 many fields, nested parameterized types, string as a type parameter).
      repeated .substrait.TypeAlias type_aliases = 9;