java.io.deephaven.proto.backplane.grpc.HierarchicalTableViewKeyTableDescriptorOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-proto-backplane-grpc Show documentation
The Deephaven proto-backplane-grpc
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: deephaven_core/proto/hierarchicaltable.proto

// Protobuf Java Version: 3.25.3
package io.deephaven.proto.backplane.grpc;

public interface HierarchicalTableViewKeyTableDescriptorOrBuilder extends
    // @@protoc_insertion_point(interface_extends:io.deephaven.proto.backplane.grpc.HierarchicalTableViewKeyTableDescriptor)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return Whether the keyTableId field is set.
   */
  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;
   * @return The keyTableId.
   */
  io.deephaven.proto.backplane.grpc.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;
   */
  io.deephaven.proto.backplane.grpc.TicketOrBuilder getKeyTableIdOrBuilder();

  /**
   *    * 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;
   * @return Whether the keyTableActionColumn field is set.
   */
  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;
   * @return The keyTableActionColumn.
   */
  java.lang.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;
   * @return The bytes for keyTableActionColumn.
   */
  com.google.protobuf.ByteString
      getKeyTableActionColumnBytes();
}