Package io.substrait.proto

Class Plan

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.substrait.proto.Plan
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PlanOrBuilder, Serializable
public final class Plan extends com.google.protobuf.GeneratedMessageV3 implements PlanOrBuilder
 Describe a set of operations to complete.
 For compactness sake, identifiers are normalized at the plan level.
Protobuf type substrait.Plan
See Also:

  • Field Details

    • VERSION_FIELD_NUMBER

      public static final int VERSION_FIELD_NUMBER
      See Also:

    • EXTENSION_URNS_FIELD_NUMBER

      public static final int EXTENSION_URNS_FIELD_NUMBER
      See Also:

    • EXTENSIONS_FIELD_NUMBER

      public static final int EXTENSIONS_FIELD_NUMBER
      See Also:

    • RELATIONS_FIELD_NUMBER

      public static final int RELATIONS_FIELD_NUMBER
      See Also:

    • ADVANCED_EXTENSIONS_FIELD_NUMBER

      public static final int ADVANCED_EXTENSIONS_FIELD_NUMBER
      See Also:

    • EXPECTED_TYPE_URLS_FIELD_NUMBER

      public static final int EXPECTED_TYPE_URLS_FIELD_NUMBER
      See Also:

    • PARAMETER_BINDINGS_FIELD_NUMBER

      public static final int PARAMETER_BINDINGS_FIELD_NUMBER
      See Also:

    • TYPE_ALIASES_FIELD_NUMBER

      public static final int TYPE_ALIASES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasVersion

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

    • getVersion

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

    • getVersionOrBuilder

      public VersionOrBuilder getVersionOrBuilder()
       Substrait version of the plan. Optional up to 0.17.0, required for later
 versions.
      .substrait.Version version = 6;
      Specified by:
      getVersionOrBuilder in interface PlanOrBuilder

    • getExtensionUrnsList

      public List<SimpleExtensionURN> getExtensionUrnsList()
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;
      Specified by:
      getExtensionUrnsList in interface PlanOrBuilder

    • getExtensionUrnsOrBuilderList

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

    • getExtensionUrnsCount

      public int getExtensionUrnsCount()
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;
      Specified by:
      getExtensionUrnsCount in interface PlanOrBuilder

    • getExtensionUrns

      public SimpleExtensionURN getExtensionUrns(int index)
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;
      Specified by:
      getExtensionUrns in interface PlanOrBuilder

    • getExtensionUrnsOrBuilder

      public SimpleExtensionURNOrBuilder getExtensionUrnsOrBuilder(int index)
       a list of extension URNs this plan may depend on
      repeated .substrait.extensions.SimpleExtensionURN extension_urns = 8;
      Specified by:
      getExtensionUrnsOrBuilder in interface PlanOrBuilder

    • getExtensionsList

      public List<SimpleExtensionDeclaration> getExtensionsList()
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;
      Specified by:
      getExtensionsList in interface PlanOrBuilder

    • getExtensionsOrBuilderList

      public List<? extends SimpleExtensionDeclarationOrBuilder> getExtensionsOrBuilderList()
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;
      Specified by:
      getExtensionsOrBuilderList in interface PlanOrBuilder

    • getExtensionsCount

      public int getExtensionsCount()
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;
      Specified by:
      getExtensionsCount in interface PlanOrBuilder

    • getExtensions

      public SimpleExtensionDeclaration getExtensions(int index)
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;
      Specified by:
      getExtensions in interface PlanOrBuilder

    • getExtensionsOrBuilder

      public SimpleExtensionDeclarationOrBuilder getExtensionsOrBuilder(int index)
       a list of extensions this plan may depend on
      repeated .substrait.extensions.SimpleExtensionDeclaration extensions = 2;
      Specified by:
      getExtensionsOrBuilder in interface PlanOrBuilder

    • getRelationsList

      public List<PlanRel> getRelationsList()
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;
      Specified by:
      getRelationsList in interface PlanOrBuilder

    • getRelationsOrBuilderList

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

    • getRelationsCount

      public int getRelationsCount()
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;
      Specified by:
      getRelationsCount in interface PlanOrBuilder

    • getRelations

      public PlanRel getRelations(int index)
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;
      Specified by:
      getRelations in interface PlanOrBuilder

    • getRelationsOrBuilder

      public PlanRelOrBuilder getRelationsOrBuilder(int index)
       one or more relation trees that are associated with this plan.
      repeated .substrait.PlanRel relations = 3;
      Specified by:
      getRelationsOrBuilder in interface PlanOrBuilder

    • hasAdvancedExtensions

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

    • getAdvancedExtensions

      public AdvancedExtension getAdvancedExtensions()
       additional extensions associated with this plan.
      .substrait.extensions.AdvancedExtension advanced_extensions = 4;
      Specified by:
      getAdvancedExtensions in interface PlanOrBuilder
      Returns:
      The advancedExtensions.

    • getAdvancedExtensionsOrBuilder

      public AdvancedExtensionOrBuilder getAdvancedExtensionsOrBuilder()
       additional extensions associated with this plan.
      .substrait.extensions.AdvancedExtension advanced_extensions = 4;
      Specified by:
      getAdvancedExtensionsOrBuilder in interface PlanOrBuilder

    • getExpectedTypeUrlsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getExpectedTypeUrlsList in interface PlanOrBuilder
      Returns:
      A list containing the expectedTypeUrls.

    • getExpectedTypeUrlsCount

      public 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;
      Specified by:
      getExpectedTypeUrlsCount in interface PlanOrBuilder
      Returns:
      The count of expectedTypeUrls.

    • getExpectedTypeUrls

      public 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;
      Specified by:
      getExpectedTypeUrls in interface PlanOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The expectedTypeUrls at the given index.

    • getExpectedTypeUrlsBytes

      public 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;
      Specified by:
      getExpectedTypeUrlsBytes in interface PlanOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the expectedTypeUrls at the given index.

    • getParameterBindingsList

      public 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;
      Specified by:
      getParameterBindingsList in interface PlanOrBuilder

    • getParameterBindingsOrBuilderList

      public 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;
      Specified by:
      getParameterBindingsOrBuilderList in interface PlanOrBuilder

    • getParameterBindingsCount

      public 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;
      Specified by:
      getParameterBindingsCount in interface PlanOrBuilder

    • getParameterBindings

      public 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;
      Specified by:
      getParameterBindings in interface PlanOrBuilder

    • getParameterBindingsOrBuilder

      public 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;
      Specified by:
      getParameterBindingsOrBuilder in interface PlanOrBuilder

    • getTypeAliasesList

      public 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;
      Specified by:
      getTypeAliasesList in interface PlanOrBuilder

    • getTypeAliasesOrBuilderList

      public 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;
      Specified by:
      getTypeAliasesOrBuilderList in interface PlanOrBuilder

    • getTypeAliasesCount

      public 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;
      Specified by:
      getTypeAliasesCount in interface PlanOrBuilder

    • getTypeAliases

      public 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;
      Specified by:
      getTypeAliases in interface PlanOrBuilder

    • getTypeAliasesOrBuilder

      public 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;
      Specified by:
      getTypeAliasesOrBuilder in interface PlanOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Plan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Plan parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Plan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Plan parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Plan parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Plan parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Plan parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Plan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Plan parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Plan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Plan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Plan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Plan.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Plan.Builder newBuilder()

    • newBuilder

      public static Plan.Builder newBuilder(Plan prototype)

    • toBuilder

      public Plan.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Plan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Plan getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Plan> parser()

    • getParserForType

      public com.google.protobuf.Parser<Plan> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Plan getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder