Class ApplyPreviewColumnsRequest

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

public final class ApplyPreviewColumnsRequest extends com.google.protobuf.GeneratedMessageV3 implements ApplyPreviewColumnsRequestOrBuilder
 Transforms the source table to avoid complex objects in columns. If no unpreviewed types are defined, this
 defaults to legacy behavior of:
  - Limiting string columns to a server-defined max length
  - Converting arrays/vectors to comma separated strings of the first N elements (again, server defined)
  - Converting all non-string, non-number, non-date types to their string representation
 
Protobuf type io.deephaven.proto.backplane.grpc.ApplyPreviewColumnsRequest
See Also:
  • Field Details

    • SOURCE_ID_FIELD_NUMBER

      public static final int SOURCE_ID_FIELD_NUMBER
      See Also:
    • RESULT_ID_FIELD_NUMBER

      public static final int RESULT_ID_FIELD_NUMBER
      See Also:
    • CONVERT_ARRAYS_FIELD_NUMBER

      public static final int CONVERT_ARRAYS_FIELD_NUMBER
      See Also:
    • UNPREVIEWED_TYPES_FIELD_NUMBER

      public static final int UNPREVIEWED_TYPES_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
    • hasSourceId

      public boolean hasSourceId()
      .io.deephaven.proto.backplane.grpc.TableReference source_id = 1;
      Specified by:
      hasSourceId in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      Whether the sourceId field is set.
    • getSourceId

      public TableReference getSourceId()
      .io.deephaven.proto.backplane.grpc.TableReference source_id = 1;
      Specified by:
      getSourceId in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      The sourceId.
    • getSourceIdOrBuilder

      public TableReferenceOrBuilder getSourceIdOrBuilder()
      .io.deephaven.proto.backplane.grpc.TableReference source_id = 1;
      Specified by:
      getSourceIdOrBuilder in interface ApplyPreviewColumnsRequestOrBuilder
    • hasResultId

      public boolean hasResultId()
      .io.deephaven.proto.backplane.grpc.Ticket result_id = 2;
      Specified by:
      hasResultId in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      Whether the resultId field is set.
    • getResultId

      public Ticket getResultId()
      .io.deephaven.proto.backplane.grpc.Ticket result_id = 2;
      Specified by:
      getResultId in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      The resultId.
    • getResultIdOrBuilder

      public TicketOrBuilder getResultIdOrBuilder()
      .io.deephaven.proto.backplane.grpc.Ticket result_id = 2;
      Specified by:
      getResultIdOrBuilder in interface ApplyPreviewColumnsRequestOrBuilder
    • getConvertArrays

      public boolean getConvertArrays()
       True to convert all arrays to strings, limiting to a server-defined max length. Expected to be unset if
       unpreviewed_types is empty.
       
      bool convert_arrays = 3;
      Specified by:
      getConvertArrays in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      The convertArrays.
    • getUnpreviewedTypesList

      public com.google.protobuf.ProtocolStringList getUnpreviewedTypesList()
       Java types to leave unconverted - all other types will be converted to strings. If empty, the server's
       legacy behavior will be used.
       
      repeated string unpreviewed_types = 4;
      Specified by:
      getUnpreviewedTypesList in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      A list containing the unpreviewedTypes.
    • getUnpreviewedTypesCount

      public int getUnpreviewedTypesCount()
       Java types to leave unconverted - all other types will be converted to strings. If empty, the server's
       legacy behavior will be used.
       
      repeated string unpreviewed_types = 4;
      Specified by:
      getUnpreviewedTypesCount in interface ApplyPreviewColumnsRequestOrBuilder
      Returns:
      The count of unpreviewedTypes.
    • getUnpreviewedTypes

      public String getUnpreviewedTypes(int index)
       Java types to leave unconverted - all other types will be converted to strings. If empty, the server's
       legacy behavior will be used.
       
      repeated string unpreviewed_types = 4;
      Specified by:
      getUnpreviewedTypes in interface ApplyPreviewColumnsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The unpreviewedTypes at the given index.
    • getUnpreviewedTypesBytes

      public com.google.protobuf.ByteString getUnpreviewedTypesBytes(int index)
       Java types to leave unconverted - all other types will be converted to strings. If empty, the server's
       legacy behavior will be used.
       
      repeated string unpreviewed_types = 4;
      Specified by:
      getUnpreviewedTypesBytes in interface ApplyPreviewColumnsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the unpreviewedTypes at the given index.
    • 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 ApplyPreviewColumnsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

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

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

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

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

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

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

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

      public static ApplyPreviewColumnsRequest.Builder newBuilder()
    • newBuilder

      public static ApplyPreviewColumnsRequest.Builder newBuilder(ApplyPreviewColumnsRequest prototype)
    • toBuilder

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

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

      public static ApplyPreviewColumnsRequest getDefaultInstance()
    • parser

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

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