org.finos.tracdap.api.DataReadResponseOrBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tracdap-api-services Show documentation

TRAC D.A.P. platform API, contains service API definitions for the TRAC platform services

The newest version!

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// NO CHECKED-IN PROTOBUF GENCODE
// source: tracdap/api/data.proto
// Protobuf Java Version: 4.28.2

package org.finos.tracdap.api;

public interface DataReadResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:tracdap.api.DataReadResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * *
   * Schema of the dataset being returned.
   *
   * The schema is provided in the first message of the response stream.
   * TRAC will always provide a full schema, regardless of whether the
   * dataset is using am external schema or an embedded one.
   * 
   *
   * optional .tracdap.metadata.SchemaDefinition schema = 1;
   * @return Whether the schema field is set.
   */
  boolean hasSchema();
  /**
   *    * *
   * Schema of the dataset being returned.
   *
   * The schema is provided in the first message of the response stream.
   * TRAC will always provide a full schema, regardless of whether the
   * dataset is using am external schema or an embedded one.
   * 
   *
   * optional .tracdap.metadata.SchemaDefinition schema = 1;
   * @return The schema.
   */
  org.finos.tracdap.metadata.SchemaDefinition getSchema();
  /**
   *    * *
   * Schema of the dataset being returned.
   *
   * The schema is provided in the first message of the response stream.
   * TRAC will always provide a full schema, regardless of whether the
   * dataset is using am external schema or an embedded one.
   * 
   *
   * optional .tracdap.metadata.SchemaDefinition schema = 1;
   */
  org.finos.tracdap.metadata.SchemaDefinitionOrBuilder getSchemaOrBuilder();

  /**
   *    * *
   * Content of the dataset, encoded in the requested format.
   *
   * The first message in the response stream will always contain an empty
   * content buffer. Subsequent messages will provided the content of the
   * dataset as a series of chunks.
   * 
   *
   * bytes content = 1000;
   * @return The content.
   */
  com.google.protobuf.ByteString getContent();
}