com.clickzetta.platform.client.api.Message Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clickzetta-java Show documentation

The java SDK for clickzetta's Lakehouse

There is a newer version: 2.0.0

package com.clickzetta.platform.client.api;

import cz.proto.ingestion.Ingestion;

import java.util.List;

public interface Message {

  /**
   * return current session id.
   *
   * @return
   */
  String getSessionId();

  /**
   * return current request batch id.
   *
   * @return
   */
  long getBatchId();

  /**
   * return current timestamp.
   *
   * @return
   */
  long getTimestamp();

  /**
   * return current schema names. List size always is 1. except multi message.
   *
   * @return
   */
  List getSchemaName();

  /**
   * return current table names. List size always is 1. except multi message.
   *
   * @return
   */
  List getTableName();

  /**
   * return all rows status in current batch request.
   * each row also have its status & row index in current batch.
   *
   * @return
   */
  List getRowStates();

  /**
   * return total row count.
   *
   * @return
   */
  long getTotalRowsCounts();

  /**
   * return error row count when if failed. otherwise return 0.
   *
   * @return
   */
  int getErrorRowsCounts();

  /**
   * return error row when it failed. otherwise return null.
   * this value only be computed when method called.
   *
   * @return
   */
  List getErrorRows();
}