com.snowflake.kafka.connector.internal.telemetry.SnowflakeTelemetryBasicInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snowflake-kafka-connector Show documentation

Snowflake Kafka Connect Sink Connector

There is a newer version: 2.4.1

Show newest version

package com.snowflake.kafka.connector.internal.telemetry;

import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.snowflake.kafka.connector.internal.KCLogger;
import net.snowflake.client.jdbc.internal.fasterxml.jackson.databind.node.ObjectNode;

/** Minimum information needed to sent to Snowflake through Telemetry API */
public abstract class SnowflakeTelemetryBasicInfo {
  public final String tableName;
  public final SnowflakeTelemetryService.TelemetryType telemetryType;

  public static final KCLogger LOGGER = new KCLogger(SnowflakeTelemetryBasicInfo.class.getName());

  /**
   * Base Constructor. Accepts a tableName and StageName.
   *
   * @param tableName Checks for Nullability
   */
  public SnowflakeTelemetryBasicInfo(
      final String tableName, SnowflakeTelemetryService.TelemetryType telemetryType) {
    Preconditions.checkArgument(
        !Strings.isNullOrEmpty(tableName), "tableName cannot be null or empty");
    this.tableName = tableName;
    this.telemetryType = telemetryType;
  }

  /**
   * Adds the required fields into the given ObjectNode which will then be used as payload in
   * Telemetry API
   *
   * @param msg ObjectNode in which extra fields needs to be added.
   */
  public abstract void dumpTo(ObjectNode msg);

  /**
   * @return true if it would suggest that their was no update to corresponding implementation's
   *     member variables. Or, in other words, the corresponding partition didnt receive any
   *     records, in which case we would not call telemetry API.
   */
  public abstract boolean isEmpty();
}