Package io.deephaven.proto.backplane.grpc

Interface HierarchicalTableViewKeyTableDescriptorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HierarchicalTableViewKeyTableDescriptor, HierarchicalTableViewKeyTableDescriptor.Builder
public interface HierarchicalTableViewKeyTableDescriptorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKeyTableActionColumn()
    The name of a column of bytes found in the key table that specifies the action desired for the node selected by the other columns for each row.
    com.google.protobuf.ByteString
    getKeyTableActionColumnBytes()
    The name of a column of bytes found in the key table that specifies the action desired for the node selected by the other columns for each row.
    Ticket
    getKeyTableId()
    Ticket that represents a Table of expanded or contracted keys from a HierarchicalTable (RollupTable or TreeTable).
    TicketOrBuilder
    getKeyTableIdOrBuilder()
    Ticket that represents a Table of expanded or contracted keys from a HierarchicalTable (RollupTable or TreeTable).
    boolean
    hasKeyTableActionColumn()
    The name of a column of bytes found in the key table that specifies the action desired for the node selected by the other columns for each row.
    boolean
    hasKeyTableId()
    Ticket that represents a Table of expanded or contracted keys from a HierarchicalTable (RollupTable or TreeTable).

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasKeyTableId

      boolean hasKeyTableId()
       Ticket that represents a Table of expanded or contracted keys from a HierarchicalTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding HierarchicalTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      .io.deephaven.proto.backplane.grpc.Ticket key_table_id = 1;
      Returns:
      Whether the keyTableId field is set.

    • getKeyTableId

      Ticket getKeyTableId()
       Ticket that represents a Table of expanded or contracted keys from a HierarchicalTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding HierarchicalTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      .io.deephaven.proto.backplane.grpc.Ticket key_table_id = 1;
      Returns:
      The keyTableId.

    • getKeyTableIdOrBuilder

      TicketOrBuilder getKeyTableIdOrBuilder()
       Ticket that represents a Table of expanded or contracted keys from a HierarchicalTable (RollupTable or TreeTable).
 The format for the key Table is dictated by the schema from the corresponding HierarchicalTableDescriptor. It is
 expected to have one column for each "expand-by column", including the "row depth column" for RollupTables only,
 and (optionally) an "action" column whose name is specified in the key_table_action_column field.
 If the Table is empty the result will have only default nodes expanded.
      .io.deephaven.proto.backplane.grpc.Ticket key_table_id = 1;

    • hasKeyTableActionColumn

      boolean hasKeyTableActionColumn()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string key_table_action_column = 2;
      Returns:
      Whether the keyTableActionColumn field is set.

    • getKeyTableActionColumn

      String getKeyTableActionColumn()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string key_table_action_column = 2;
      Returns:
      The keyTableActionColumn.

    • getKeyTableActionColumnBytes

      com.google.protobuf.ByteString getKeyTableActionColumnBytes()
       The name of a column of bytes found in the key table that specifies the action desired for the node selected by
 the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be
 expanded along with their descendants, and 4 for nodes that should be contracted.
 If this column name is not present, all nodes in the key table will be expanded without their descendants.
      optional string key_table_action_column = 2;
      Returns:
      The bytes for keyTableActionColumn.