Class HierarchicalTableDescriptor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.deephaven.proto.backplane.grpc.HierarchicalTableDescriptor
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HierarchicalTableDescriptorOrBuilder, Serializable

public final class HierarchicalTableDescriptor extends com.google.protobuf.GeneratedMessageV3 implements HierarchicalTableDescriptorOrBuilder
Protobuf type io.deephaven.proto.backplane.grpc.HierarchicalTableDescriptor
See Also:
  • Field Details

    • SNAPSHOT_SCHEMA_FIELD_NUMBER

      public static final int SNAPSHOT_SCHEMA_FIELD_NUMBER
      See Also:
    • IS_STATIC_FIELD_NUMBER

      public static final int IS_STATIC_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
    • getSnapshotSchema

      public com.google.protobuf.ByteString getSnapshotSchema()
       Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
       Field metadata is used to convey additional information about the structure of the HierarchicalTable, the
       special roles some columns play, and the relationships between columns.
      
       "hierarchicalTable.isStructuralColumn" is always "true" if set, and is set on columns that should be included on
       every snapshot or subscription request, but should not be directly user-visible.
      
       "hierarchicalTable.isExpandByColumn" is always "true" if set, and is set on all the columns that must be included
       in a HierarchicalTableViewRequest's key table, if a key table is specified. These columns are generally
       user-visible and displayed before other columns, unless they also have "hierarchicalTable.isStructuralColumn" set.
      
       "hierarchicalTable.isRowDepthColumn" is always "true" if set, and is set on a single column that specifies the
       depth of a row. That column will always have "hierarchicalTable.isExpandByColumn" set for RollupTables, but never
       for TreeTables.
      
       "hierarchicalTable.isRowExpandedColumn" is always "true" if set, and is set on a single nullable column of
       booleans that specifies whether a row is expandable or expanded. Values will be null for rows that are not
       expandable, true for expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no
       children to expand, and hence will always have a null value for this column.
      
       "rollupTable.isAggregatedNodeColumn" is always "true" if set, and is set on all columns of a RollupTable that
       belong to the aggregated nodes.
      
       "rollupTable.isConstituentNodeColumn" is always "true" if set, and is set on all columns of a RollupTable that
       belong to the constituent nodes. No such columns will be present if constituents are not included in the
       RollupTable.
      
       "rollupTable.isGroupByColumn" is always "true" if set, and is set on all columns of a RollupTable that are
       "group-by columns", whether the node is aggregated or constituent. All nodes have the same names and types for
       columns labeled in this way. Such columns will always have "hierarchicalTable.isExpandByColumn" set if and only if
       they also have "rollupTable.isAggregatedNodeColumn" set.
      
       "rollupTable.aggregationInputColumnName" is set to the (string) name of the corresponding constituent column that
       was used as input to this aggregation node column. May have an empty value, because some aggregations take no
       input columns, for example "Count". This is only ever present on columns with "rollupTable.isAggregatedNodeColumn"
       set.
      
       "treeTable.isNodeColumn" is always "true" if set, and is set on all columns of a TreeTable that nodes inherit from
       the source Table.
      
       "treeTable.isIdentifierColumn" is always "true" if set, and is set on the single column that uniquely identifies a
       TreeTable row and links it to its children. Such columns will always have "hierarchicalTable.isExpandByColumn"
       set.
      
       "treeTable.isParentIdentifierColumn" is always "true" if set, and is set on the single column that links a
       TreeTable row to its parent row.
       
      bytes snapshot_schema = 1;
      Specified by:
      getSnapshotSchema in interface HierarchicalTableDescriptorOrBuilder
      Returns:
      The snapshotSchema.
    • getIsStatic

      public boolean getIsStatic()
       Whether or not this table might change.
       
      bool is_static = 2;
      Specified by:
      getIsStatic in interface HierarchicalTableDescriptorOrBuilder
      Returns:
      The isStatic.
    • 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 HierarchicalTableDescriptor parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static HierarchicalTableDescriptor parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static HierarchicalTableDescriptor parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static HierarchicalTableDescriptor.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static HierarchicalTableDescriptor getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<HierarchicalTableDescriptor> parser()
    • getParserForType

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