Package io.substrait.proto

Class NamedStruct

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.substrait.proto.NamedStruct
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NamedStructOrBuilder, Serializable
public final class NamedStruct extends com.google.protobuf.GeneratedMessageV3 implements NamedStructOrBuilder
 A message for modeling name/type pairs.

 Useful for representing relation schemas.

 Notes:

 * The names field is in depth-first order.

 For example a schema such as:

 a: int64
 b: struct<c: float32, d: string>

 would have a `names` field that looks like:

 ["a", "b", "c", "d"]

 * Only struct fields are contained in this field's elements,
 * Map keys should be traversed first, then values when producing/consuming
 * When used to represent a relation schema, the outermost struct's
   nullability should be NULLABILITY_REQUIRED.
Protobuf type substrait.NamedStruct
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    NamedStruct.Builder
    A message for modeling name/type pairs.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NAMES_FIELD_NUMBER
     
    static final int
    STRUCT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static NamedStruct
    getDefaultInstance()
     
    NamedStruct
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getNames(int index)
    list of names in dfs order
    com.google.protobuf.ByteString
    getNamesBytes(int index)
    list of names in dfs order
    int
    getNamesCount()
    list of names in dfs order
    com.google.protobuf.ProtocolStringList
    getNamesList()
    list of names in dfs order
    com.google.protobuf.Parser<NamedStruct>
    getParserForType()
     
    int
    getSerializedSize()
     
    Type.Struct
    getStruct()
    .substrait.Type.Struct struct = 2;
    Type.StructOrBuilder
    getStructOrBuilder()
    .substrait.Type.Struct struct = 2;
    int
    hashCode()
     
    boolean
    hasStruct()
    .substrait.Type.Struct struct = 2;
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static NamedStruct.Builder
    newBuilder()
     
    static NamedStruct.Builder
    newBuilder(NamedStruct prototype)
     
    NamedStruct.Builder
    newBuilderForType()
     
    protected NamedStruct.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static NamedStruct
    parseDelimitedFrom(InputStream input)
     
    static NamedStruct
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedStruct
    parseFrom(byte[] data)
     
    static NamedStruct
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedStruct
    parseFrom(com.google.protobuf.ByteString data)
     
    static NamedStruct
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedStruct
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static NamedStruct
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedStruct
    parseFrom(InputStream input)
     
    static NamedStruct
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NamedStruct
    parseFrom(ByteBuffer data)
     
    static NamedStruct
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<NamedStruct>
    parser()
     
    NamedStruct.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • getNamesList

      public com.google.protobuf.ProtocolStringList getNamesList()
       list of names in dfs order
      repeated string names = 1;
      Specified by:
      getNamesList in interface NamedStructOrBuilder
      Returns:
      A list containing the names.

    • getNamesCount

      public int getNamesCount()
       list of names in dfs order
      repeated string names = 1;
      Specified by:
      getNamesCount in interface NamedStructOrBuilder
      Returns:
      The count of names.

    • getNames

      public String getNames(int index)
       list of names in dfs order
      repeated string names = 1;
      Specified by:
      getNames in interface NamedStructOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The names at the given index.

    • getNamesBytes

      public com.google.protobuf.ByteString getNamesBytes(int index)
       list of names in dfs order
      repeated string names = 1;
      Specified by:
      getNamesBytes in interface NamedStructOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the names at the given index.

    • hasStruct

      public boolean hasStruct()
      .substrait.Type.Struct struct = 2;
      Specified by:
      hasStruct in interface NamedStructOrBuilder
      Returns:
      Whether the struct field is set.

    • getStruct

      public Type.Struct getStruct()
      .substrait.Type.Struct struct = 2;
      Specified by:
      getStruct in interface NamedStructOrBuilder
      Returns:
      The struct.

    • getStructOrBuilder

      public Type.StructOrBuilder getStructOrBuilder()
      .substrait.Type.Struct struct = 2;
      Specified by:
      getStructOrBuilder in interface NamedStructOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static NamedStruct.Builder newBuilder()

    • newBuilder

      public static NamedStruct.Builder newBuilder(NamedStruct prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static NamedStruct getDefaultInstance()

    • parser

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

    • getParserForType

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