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;

    • getExtensionUrisList

      List<SimpleExtensionURI> getExtensionUrisList()
       a list of yaml specifications this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURI extension_uris = 1;

    • getExtensionUris

      SimpleExtensionURI getExtensionUris(int index)
       a list of yaml specifications this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURI extension_uris = 1;

    • getExtensionUrisCount

      int getExtensionUrisCount()
       a list of yaml specifications this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURI extension_uris = 1;

    • getExtensionUrisOrBuilderList

      List<? extends SimpleExtensionURIOrBuilder> getExtensionUrisOrBuilderList()
       a list of yaml specifications this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURI extension_uris = 1;

    • getExtensionUrisOrBuilder

      SimpleExtensionURIOrBuilder getExtensionUrisOrBuilder(int index)
       a list of yaml specifications this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURI extension_uris = 1;

    • 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;