Package io.substrait.proto

Class RelCommon.Hint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.substrait.proto.RelCommon.Hint
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RelCommon.HintOrBuilder, Serializable
Enclosing class:
RelCommon
public static final class RelCommon.Hint extends com.google.protobuf.GeneratedMessageV3 implements RelCommon.HintOrBuilder
 Changes to the operation that can influence efficiency/performance but
 should not impact correctness.
Protobuf type substrait.RelCommon.Hint
See Also:

  • Field Details

    • STATS_FIELD_NUMBER

      public static final int STATS_FIELD_NUMBER
      See Also:

    • CONSTRAINT_FIELD_NUMBER

      public static final int CONSTRAINT_FIELD_NUMBER
      See Also:

    • ALIAS_FIELD_NUMBER

      public static final int ALIAS_FIELD_NUMBER
      See Also:

    • OUTPUT_NAMES_FIELD_NUMBER

      public static final int OUTPUT_NAMES_FIELD_NUMBER
      See Also:

    • ADVANCED_EXTENSION_FIELD_NUMBER

      public static final int ADVANCED_EXTENSION_FIELD_NUMBER
      See Also:

    • SAVED_COMPUTATIONS_FIELD_NUMBER

      public static final int SAVED_COMPUTATIONS_FIELD_NUMBER
      See Also:

    • LOADED_COMPUTATIONS_FIELD_NUMBER

      public static final int LOADED_COMPUTATIONS_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

    • hasStats

      public boolean hasStats()
      .substrait.RelCommon.Hint.Stats stats = 1;
      Specified by:
      hasStats in interface RelCommon.HintOrBuilder
      Returns:
      Whether the stats field is set.

    • getStats

      public RelCommon.Hint.Stats getStats()
      .substrait.RelCommon.Hint.Stats stats = 1;
      Specified by:
      getStats in interface RelCommon.HintOrBuilder
      Returns:
      The stats.

    • getStatsOrBuilder

      public RelCommon.Hint.StatsOrBuilder getStatsOrBuilder()
      .substrait.RelCommon.Hint.Stats stats = 1;
      Specified by:
      getStatsOrBuilder in interface RelCommon.HintOrBuilder

    • hasConstraint

      public boolean hasConstraint()
      .substrait.RelCommon.Hint.RuntimeConstraint constraint = 2;
      Specified by:
      hasConstraint in interface RelCommon.HintOrBuilder
      Returns:
      Whether the constraint field is set.

    • getConstraint

      public RelCommon.Hint.RuntimeConstraint getConstraint()
      .substrait.RelCommon.Hint.RuntimeConstraint constraint = 2;
      Specified by:
      getConstraint in interface RelCommon.HintOrBuilder
      Returns:
      The constraint.

    • getConstraintOrBuilder

      public RelCommon.Hint.RuntimeConstraintOrBuilder getConstraintOrBuilder()
      .substrait.RelCommon.Hint.RuntimeConstraint constraint = 2;
      Specified by:
      getConstraintOrBuilder in interface RelCommon.HintOrBuilder

    • getAlias

      public String getAlias()
       Name (alias) for this relation. Can be used for e.g. qualifying the relation (see e.g.
 Spark's SubqueryAlias), or debugging.
      string alias = 3;
      Specified by:
      getAlias in interface RelCommon.HintOrBuilder
      Returns:
      The alias.

    • getAliasBytes

      public com.google.protobuf.ByteString getAliasBytes()
       Name (alias) for this relation. Can be used for e.g. qualifying the relation (see e.g.
 Spark's SubqueryAlias), or debugging.
      string alias = 3;
      Specified by:
      getAliasBytes in interface RelCommon.HintOrBuilder
      Returns:
      The bytes for alias.

    • getOutputNamesList

      public com.google.protobuf.ProtocolStringList getOutputNamesList()
       Assigns alternative output field names for any relation.  Equivalent to the names field
 in RelRoot but applies to the output of the relation this RelCommon is attached to.
      repeated string output_names = 4;
      Specified by:
      getOutputNamesList in interface RelCommon.HintOrBuilder
      Returns:
      A list containing the outputNames.

    • getOutputNamesCount

      public int getOutputNamesCount()
       Assigns alternative output field names for any relation.  Equivalent to the names field
 in RelRoot but applies to the output of the relation this RelCommon is attached to.
      repeated string output_names = 4;
      Specified by:
      getOutputNamesCount in interface RelCommon.HintOrBuilder
      Returns:
      The count of outputNames.

    • getOutputNames

      public String getOutputNames(int index)
       Assigns alternative output field names for any relation.  Equivalent to the names field
 in RelRoot but applies to the output of the relation this RelCommon is attached to.
      repeated string output_names = 4;
      Specified by:
      getOutputNames in interface RelCommon.HintOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The outputNames at the given index.

    • getOutputNamesBytes

      public com.google.protobuf.ByteString getOutputNamesBytes(int index)
       Assigns alternative output field names for any relation.  Equivalent to the names field
 in RelRoot but applies to the output of the relation this RelCommon is attached to.
      repeated string output_names = 4;
      Specified by:
      getOutputNamesBytes in interface RelCommon.HintOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the outputNames at the given index.

    • hasAdvancedExtension

      public boolean hasAdvancedExtension()
      .substrait.extensions.AdvancedExtension advanced_extension = 10;
      Specified by:
      hasAdvancedExtension in interface RelCommon.HintOrBuilder
      Returns:
      Whether the advancedExtension field is set.

    • getAdvancedExtension

      public AdvancedExtension getAdvancedExtension()
      .substrait.extensions.AdvancedExtension advanced_extension = 10;
      Specified by:
      getAdvancedExtension in interface RelCommon.HintOrBuilder
      Returns:
      The advancedExtension.

    • getAdvancedExtensionOrBuilder

      public AdvancedExtensionOrBuilder getAdvancedExtensionOrBuilder()
      .substrait.extensions.AdvancedExtension advanced_extension = 10;
      Specified by:
      getAdvancedExtensionOrBuilder in interface RelCommon.HintOrBuilder

    • getSavedComputationsList

      public List<RelCommon.Hint.SavedComputation> getSavedComputationsList()
       Save or load a system-specific computation for use in optimizing a remote operation.
 The anchor refers to the source/destination of the computation.  The computation type
 and number refer to the current relation.
      repeated .substrait.RelCommon.Hint.SavedComputation saved_computations = 11;
      Specified by:
      getSavedComputationsList in interface RelCommon.HintOrBuilder

    • getSavedComputationsOrBuilderList

      public List<? extends RelCommon.Hint.SavedComputationOrBuilder> getSavedComputationsOrBuilderList()
       Save or load a system-specific computation for use in optimizing a remote operation.
 The anchor refers to the source/destination of the computation.  The computation type
 and number refer to the current relation.
      repeated .substrait.RelCommon.Hint.SavedComputation saved_computations = 11;
      Specified by:
      getSavedComputationsOrBuilderList in interface RelCommon.HintOrBuilder

    • getSavedComputationsCount

      public int getSavedComputationsCount()
       Save or load a system-specific computation for use in optimizing a remote operation.
 The anchor refers to the source/destination of the computation.  The computation type
 and number refer to the current relation.
      repeated .substrait.RelCommon.Hint.SavedComputation saved_computations = 11;
      Specified by:
      getSavedComputationsCount in interface RelCommon.HintOrBuilder

    • getSavedComputations

      public RelCommon.Hint.SavedComputation getSavedComputations(int index)
       Save or load a system-specific computation for use in optimizing a remote operation.
 The anchor refers to the source/destination of the computation.  The computation type
 and number refer to the current relation.
      repeated .substrait.RelCommon.Hint.SavedComputation saved_computations = 11;
      Specified by:
      getSavedComputations in interface RelCommon.HintOrBuilder

    • getSavedComputationsOrBuilder

      public RelCommon.Hint.SavedComputationOrBuilder getSavedComputationsOrBuilder(int index)
       Save or load a system-specific computation for use in optimizing a remote operation.
 The anchor refers to the source/destination of the computation.  The computation type
 and number refer to the current relation.
      repeated .substrait.RelCommon.Hint.SavedComputation saved_computations = 11;
      Specified by:
      getSavedComputationsOrBuilder in interface RelCommon.HintOrBuilder

    • getLoadedComputationsList

      public List<RelCommon.Hint.LoadedComputation> getLoadedComputationsList()
      repeated .substrait.RelCommon.Hint.LoadedComputation loaded_computations = 12;
      Specified by:
      getLoadedComputationsList in interface RelCommon.HintOrBuilder

    • getLoadedComputationsOrBuilderList

      public List<? extends RelCommon.Hint.LoadedComputationOrBuilder> getLoadedComputationsOrBuilderList()
      repeated .substrait.RelCommon.Hint.LoadedComputation loaded_computations = 12;
      Specified by:
      getLoadedComputationsOrBuilderList in interface RelCommon.HintOrBuilder

    • getLoadedComputationsCount

      public int getLoadedComputationsCount()
      repeated .substrait.RelCommon.Hint.LoadedComputation loaded_computations = 12;
      Specified by:
      getLoadedComputationsCount in interface RelCommon.HintOrBuilder

    • getLoadedComputations

      public RelCommon.Hint.LoadedComputation getLoadedComputations(int index)
      repeated .substrait.RelCommon.Hint.LoadedComputation loaded_computations = 12;
      Specified by:
      getLoadedComputations in interface RelCommon.HintOrBuilder

    • getLoadedComputationsOrBuilder

      public RelCommon.Hint.LoadedComputationOrBuilder getLoadedComputationsOrBuilder(int index)
      repeated .substrait.RelCommon.Hint.LoadedComputation loaded_computations = 12;
      Specified by:
      getLoadedComputationsOrBuilder in interface RelCommon.HintOrBuilder

    • 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 RelCommon.Hint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RelCommon.Hint parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RelCommon.Hint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RelCommon.Hint.Builder newBuilder()

    • newBuilder

      public static RelCommon.Hint.Builder newBuilder(RelCommon.Hint prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RelCommon.Hint getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RelCommon.Hint> 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 RelCommon.Hint getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder