All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.radarcns.connector.oura.OuraSleepPhase Maven / Gradle / Ivy

The newest version!
/**
 * Autogenerated by Avro
 *
 * DO NOT EDIT DIRECTLY
 */
package org.radarcns.connector.oura;

import org.apache.avro.generic.GenericArray;
import org.apache.avro.specific.SpecificData;
import org.apache.avro.util.Utf8;
import org.apache.avro.message.BinaryMessageEncoder;
import org.apache.avro.message.BinaryMessageDecoder;
import org.apache.avro.message.SchemaStore;

/** Oura Sleep phases in 5-minute intervals as defined in https://cloud.ouraring.com/v2/docs#operation/Single_sleep_Document_v2_usercollection_sleep__document_id__get. */
@org.apache.avro.specific.AvroGenerated
public class OuraSleepPhase extends org.apache.avro.specific.SpecificRecordBase implements org.apache.avro.specific.SpecificRecord {
  private static final long serialVersionUID = -8035897884801310692L;


  public static final org.apache.avro.Schema SCHEMA$ = new org.apache.avro.Schema.Parser().parse("{\"type\":\"record\",\"name\":\"OuraSleepPhase\",\"namespace\":\"org.radarcns.connector.oura\",\"doc\":\"Oura Sleep phases in 5-minute intervals as defined in https://cloud.ouraring.com/v2/docs#operation/Single_sleep_Document_v2_usercollection_sleep__document_id__get.\",\"fields\":[{\"name\":\"time\",\"type\":\"double\",\"doc\":\"Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).\"},{\"name\":\"timeReceived\",\"type\":\"double\",\"doc\":\"Time that this record was collected by a service in seconds since the Unix Epoch (s).\"},{\"name\":\"id\",\"type\":[\"null\",{\"type\":\"string\",\"avro.java.string\":\"String\"}],\"doc\":\"Unique identifier of the Oura sleep record the sleep stage data is taken from.\",\"default\":null},{\"name\":\"phase\",\"type\":{\"type\":\"enum\",\"name\":\"OuraSleepPhaseType\",\"doc\":\"Sleep phase type as computed by Oura.\",\"symbols\":[\"DEEP\",\"LIGHT\",\"REM\",\"AWAKE\",\"UNKNOWN\"]},\"doc\":\"Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).\",\"default\":\"UNKNOWN\"}]}");
  public static org.apache.avro.Schema getClassSchema() { return SCHEMA$; }

  private static final SpecificData MODEL$ = new SpecificData();

  private static final BinaryMessageEncoder ENCODER =
      new BinaryMessageEncoder<>(MODEL$, SCHEMA$);

  private static final BinaryMessageDecoder DECODER =
      new BinaryMessageDecoder<>(MODEL$, SCHEMA$);

  /**
   * Return the BinaryMessageEncoder instance used by this class.
   * @return the message encoder used by this class
   */
  public static BinaryMessageEncoder getEncoder() {
    return ENCODER;
  }

  /**
   * Return the BinaryMessageDecoder instance used by this class.
   * @return the message decoder used by this class
   */
  public static BinaryMessageDecoder getDecoder() {
    return DECODER;
  }

  /**
   * Create a new BinaryMessageDecoder instance for this class that uses the specified {@link SchemaStore}.
   * @param resolver a {@link SchemaStore} used to find schemas by fingerprint
   * @return a BinaryMessageDecoder instance for this class backed by the given SchemaStore
   */
  public static BinaryMessageDecoder createDecoder(SchemaStore resolver) {
    return new BinaryMessageDecoder<>(MODEL$, SCHEMA$, resolver);
  }

  /**
   * Serializes this OuraSleepPhase to a ByteBuffer.
   * @return a buffer holding the serialized data for this instance
   * @throws java.io.IOException if this instance could not be serialized
   */
  public java.nio.ByteBuffer toByteBuffer() throws java.io.IOException {
    return ENCODER.encode(this);
  }

  /**
   * Deserializes a OuraSleepPhase from a ByteBuffer.
   * @param b a byte buffer holding serialized data for an instance of this class
   * @return a OuraSleepPhase instance decoded from the given buffer
   * @throws java.io.IOException if the given bytes could not be deserialized into an instance of this class
   */
  public static OuraSleepPhase fromByteBuffer(
      java.nio.ByteBuffer b) throws java.io.IOException {
    return DECODER.decode(b);
  }

  /** Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). */
  private double time;
  /** Time that this record was collected by a service in seconds since the Unix Epoch (s). */
  private double timeReceived;
  /** Unique identifier of the Oura sleep record the sleep stage data is taken from. */
  private java.lang.String id;
  /** Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API). */
  private org.radarcns.connector.oura.OuraSleepPhaseType phase;

  /**
   * Default constructor.  Note that this does not initialize fields
   * to their default values from the schema.  If that is desired then
   * one should use newBuilder().
   */
  public OuraSleepPhase() {}

  /**
   * All-args constructor.
   * @param time Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
   * @param timeReceived Time that this record was collected by a service in seconds since the Unix Epoch (s).
   * @param id Unique identifier of the Oura sleep record the sleep stage data is taken from.
   * @param phase Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
   */
  public OuraSleepPhase(java.lang.Double time, java.lang.Double timeReceived, java.lang.String id, org.radarcns.connector.oura.OuraSleepPhaseType phase) {
    this.time = time;
    this.timeReceived = timeReceived;
    this.id = id;
    this.phase = phase;
  }

  @Override
  public org.apache.avro.specific.SpecificData getSpecificData() { return MODEL$; }

  @Override
  public org.apache.avro.Schema getSchema() { return SCHEMA$; }

  // Used by DatumWriter.  Applications should not call.
  @Override
  public java.lang.Object get(int field$) {
    switch (field$) {
    case 0: return time;
    case 1: return timeReceived;
    case 2: return id;
    case 3: return phase;
    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
    }
  }

  // Used by DatumReader.  Applications should not call.
  @Override
  @SuppressWarnings(value="unchecked")
  public void put(int field$, java.lang.Object value$) {
    switch (field$) {
    case 0: time = (java.lang.Double)value$; break;
    case 1: timeReceived = (java.lang.Double)value$; break;
    case 2: id = value$ != null ? value$.toString() : null; break;
    case 3: phase = (org.radarcns.connector.oura.OuraSleepPhaseType)value$; break;
    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
    }
  }

  /**
   * Gets the value of the 'time' field.
   * @return Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
   */
  public double getTime() {
    return time;
  }


  /**
   * Sets the value of the 'time' field.
   * Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
   * @param value the value to set.
   */
  public void setTime(double value) {
    this.time = value;
  }

  /**
   * Gets the value of the 'timeReceived' field.
   * @return Time that this record was collected by a service in seconds since the Unix Epoch (s).
   */
  public double getTimeReceived() {
    return timeReceived;
  }


  /**
   * Sets the value of the 'timeReceived' field.
   * Time that this record was collected by a service in seconds since the Unix Epoch (s).
   * @param value the value to set.
   */
  public void setTimeReceived(double value) {
    this.timeReceived = value;
  }

  /**
   * Gets the value of the 'id' field.
   * @return Unique identifier of the Oura sleep record the sleep stage data is taken from.
   */
  public java.lang.String getId() {
    return id;
  }


  /**
   * Sets the value of the 'id' field.
   * Unique identifier of the Oura sleep record the sleep stage data is taken from.
   * @param value the value to set.
   */
  public void setId(java.lang.String value) {
    this.id = value;
  }

  /**
   * Gets the value of the 'phase' field.
   * @return Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
   */
  public org.radarcns.connector.oura.OuraSleepPhaseType getPhase() {
    return phase;
  }


  /**
   * Sets the value of the 'phase' field.
   * Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
   * @param value the value to set.
   */
  public void setPhase(org.radarcns.connector.oura.OuraSleepPhaseType value) {
    this.phase = value;
  }

  /**
   * Creates a new OuraSleepPhase RecordBuilder.
   * @return A new OuraSleepPhase RecordBuilder
   */
  public static org.radarcns.connector.oura.OuraSleepPhase.Builder newBuilder() {
    return new org.radarcns.connector.oura.OuraSleepPhase.Builder();
  }

  /**
   * Creates a new OuraSleepPhase RecordBuilder by copying an existing Builder.
   * @param other The existing builder to copy.
   * @return A new OuraSleepPhase RecordBuilder
   */
  public static org.radarcns.connector.oura.OuraSleepPhase.Builder newBuilder(org.radarcns.connector.oura.OuraSleepPhase.Builder other) {
    if (other == null) {
      return new org.radarcns.connector.oura.OuraSleepPhase.Builder();
    } else {
      return new org.radarcns.connector.oura.OuraSleepPhase.Builder(other);
    }
  }

  /**
   * Creates a new OuraSleepPhase RecordBuilder by copying an existing OuraSleepPhase instance.
   * @param other The existing instance to copy.
   * @return A new OuraSleepPhase RecordBuilder
   */
  public static org.radarcns.connector.oura.OuraSleepPhase.Builder newBuilder(org.radarcns.connector.oura.OuraSleepPhase other) {
    if (other == null) {
      return new org.radarcns.connector.oura.OuraSleepPhase.Builder();
    } else {
      return new org.radarcns.connector.oura.OuraSleepPhase.Builder(other);
    }
  }

  /**
   * RecordBuilder for OuraSleepPhase instances.
   */
  @org.apache.avro.specific.AvroGenerated
  public static class Builder extends org.apache.avro.specific.SpecificRecordBuilderBase
    implements org.apache.avro.data.RecordBuilder {

    /** Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). */
    private double time;
    /** Time that this record was collected by a service in seconds since the Unix Epoch (s). */
    private double timeReceived;
    /** Unique identifier of the Oura sleep record the sleep stage data is taken from. */
    private java.lang.String id;
    /** Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API). */
    private org.radarcns.connector.oura.OuraSleepPhaseType phase;

    /** Creates a new Builder */
    private Builder() {
      super(SCHEMA$, MODEL$);
    }

    /**
     * Creates a Builder by copying an existing Builder.
     * @param other The existing Builder to copy.
     */
    private Builder(org.radarcns.connector.oura.OuraSleepPhase.Builder other) {
      super(other);
      if (isValidValue(fields()[0], other.time)) {
        this.time = data().deepCopy(fields()[0].schema(), other.time);
        fieldSetFlags()[0] = other.fieldSetFlags()[0];
      }
      if (isValidValue(fields()[1], other.timeReceived)) {
        this.timeReceived = data().deepCopy(fields()[1].schema(), other.timeReceived);
        fieldSetFlags()[1] = other.fieldSetFlags()[1];
      }
      if (isValidValue(fields()[2], other.id)) {
        this.id = data().deepCopy(fields()[2].schema(), other.id);
        fieldSetFlags()[2] = other.fieldSetFlags()[2];
      }
      if (isValidValue(fields()[3], other.phase)) {
        this.phase = data().deepCopy(fields()[3].schema(), other.phase);
        fieldSetFlags()[3] = other.fieldSetFlags()[3];
      }
    }

    /**
     * Creates a Builder by copying an existing OuraSleepPhase instance
     * @param other The existing instance to copy.
     */
    private Builder(org.radarcns.connector.oura.OuraSleepPhase other) {
      super(SCHEMA$, MODEL$);
      if (isValidValue(fields()[0], other.time)) {
        this.time = data().deepCopy(fields()[0].schema(), other.time);
        fieldSetFlags()[0] = true;
      }
      if (isValidValue(fields()[1], other.timeReceived)) {
        this.timeReceived = data().deepCopy(fields()[1].schema(), other.timeReceived);
        fieldSetFlags()[1] = true;
      }
      if (isValidValue(fields()[2], other.id)) {
        this.id = data().deepCopy(fields()[2].schema(), other.id);
        fieldSetFlags()[2] = true;
      }
      if (isValidValue(fields()[3], other.phase)) {
        this.phase = data().deepCopy(fields()[3].schema(), other.phase);
        fieldSetFlags()[3] = true;
      }
    }

    /**
      * Gets the value of the 'time' field.
      * Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
      * @return The value.
      */
    public double getTime() {
      return time;
    }


    /**
      * Sets the value of the 'time' field.
      * Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
      * @param value The value of 'time'.
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder setTime(double value) {
      validate(fields()[0], value);
      this.time = value;
      fieldSetFlags()[0] = true;
      return this;
    }

    /**
      * Checks whether the 'time' field has been set.
      * Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
      * @return True if the 'time' field has been set, false otherwise.
      */
    public boolean hasTime() {
      return fieldSetFlags()[0];
    }


    /**
      * Clears the value of the 'time' field.
      * Start time of the sleep phase in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp).
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder clearTime() {
      fieldSetFlags()[0] = false;
      return this;
    }

    /**
      * Gets the value of the 'timeReceived' field.
      * Time that this record was collected by a service in seconds since the Unix Epoch (s).
      * @return The value.
      */
    public double getTimeReceived() {
      return timeReceived;
    }


    /**
      * Sets the value of the 'timeReceived' field.
      * Time that this record was collected by a service in seconds since the Unix Epoch (s).
      * @param value The value of 'timeReceived'.
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder setTimeReceived(double value) {
      validate(fields()[1], value);
      this.timeReceived = value;
      fieldSetFlags()[1] = true;
      return this;
    }

    /**
      * Checks whether the 'timeReceived' field has been set.
      * Time that this record was collected by a service in seconds since the Unix Epoch (s).
      * @return True if the 'timeReceived' field has been set, false otherwise.
      */
    public boolean hasTimeReceived() {
      return fieldSetFlags()[1];
    }


    /**
      * Clears the value of the 'timeReceived' field.
      * Time that this record was collected by a service in seconds since the Unix Epoch (s).
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder clearTimeReceived() {
      fieldSetFlags()[1] = false;
      return this;
    }

    /**
      * Gets the value of the 'id' field.
      * Unique identifier of the Oura sleep record the sleep stage data is taken from.
      * @return The value.
      */
    public java.lang.String getId() {
      return id;
    }


    /**
      * Sets the value of the 'id' field.
      * Unique identifier of the Oura sleep record the sleep stage data is taken from.
      * @param value The value of 'id'.
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder setId(java.lang.String value) {
      validate(fields()[2], value);
      this.id = value;
      fieldSetFlags()[2] = true;
      return this;
    }

    /**
      * Checks whether the 'id' field has been set.
      * Unique identifier of the Oura sleep record the sleep stage data is taken from.
      * @return True if the 'id' field has been set, false otherwise.
      */
    public boolean hasId() {
      return fieldSetFlags()[2];
    }


    /**
      * Clears the value of the 'id' field.
      * Unique identifier of the Oura sleep record the sleep stage data is taken from.
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder clearId() {
      id = null;
      fieldSetFlags()[2] = false;
      return this;
    }

    /**
      * Gets the value of the 'phase' field.
      * Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
      * @return The value.
      */
    public org.radarcns.connector.oura.OuraSleepPhaseType getPhase() {
      return phase;
    }


    /**
      * Sets the value of the 'phase' field.
      * Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
      * @param value The value of 'phase'.
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder setPhase(org.radarcns.connector.oura.OuraSleepPhaseType value) {
      validate(fields()[3], value);
      this.phase = value;
      fieldSetFlags()[3] = true;
      return this;
    }

    /**
      * Checks whether the 'phase' field has been set.
      * Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
      * @return True if the 'phase' field has been set, false otherwise.
      */
    public boolean hasPhase() {
      return fieldSetFlags()[3];
    }


    /**
      * Clears the value of the 'phase' field.
      * Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API).
      * @return This builder.
      */
    public org.radarcns.connector.oura.OuraSleepPhase.Builder clearPhase() {
      phase = null;
      fieldSetFlags()[3] = false;
      return this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public OuraSleepPhase build() {
      try {
        OuraSleepPhase record = new OuraSleepPhase();
        record.time = fieldSetFlags()[0] ? this.time : (java.lang.Double) defaultValue(fields()[0]);
        record.timeReceived = fieldSetFlags()[1] ? this.timeReceived : (java.lang.Double) defaultValue(fields()[1]);
        record.id = fieldSetFlags()[2] ? this.id : (java.lang.String) defaultValue(fields()[2]);
        record.phase = fieldSetFlags()[3] ? this.phase : (org.radarcns.connector.oura.OuraSleepPhaseType) defaultValue(fields()[3]);
        return record;
      } catch (org.apache.avro.AvroMissingFieldException e) {
        throw e;
      } catch (java.lang.Exception e) {
        throw new org.apache.avro.AvroRuntimeException(e);
      }
    }
  }

  @SuppressWarnings("unchecked")
  private static final org.apache.avro.io.DatumWriter
    WRITER$ = (org.apache.avro.io.DatumWriter)MODEL$.createDatumWriter(SCHEMA$);

  @Override public void writeExternal(java.io.ObjectOutput out)
    throws java.io.IOException {
    WRITER$.write(this, SpecificData.getEncoder(out));
  }

  @SuppressWarnings("unchecked")
  private static final org.apache.avro.io.DatumReader
    READER$ = (org.apache.avro.io.DatumReader)MODEL$.createDatumReader(SCHEMA$);

  @Override public void readExternal(java.io.ObjectInput in)
    throws java.io.IOException {
    READER$.read(this, SpecificData.getDecoder(in));
  }

  @Override protected boolean hasCustomCoders() { return true; }

  @Override public void customEncode(org.apache.avro.io.Encoder out)
    throws java.io.IOException
  {
    out.writeDouble(this.time);

    out.writeDouble(this.timeReceived);

    if (this.id == null) {
      out.writeIndex(0);
      out.writeNull();
    } else {
      out.writeIndex(1);
      out.writeString(this.id);
    }

    out.writeEnum(this.phase.ordinal());

  }

  @Override public void customDecode(org.apache.avro.io.ResolvingDecoder in)
    throws java.io.IOException
  {
    org.apache.avro.Schema.Field[] fieldOrder = in.readFieldOrderIfDiff();
    if (fieldOrder == null) {
      this.time = in.readDouble();

      this.timeReceived = in.readDouble();

      if (in.readIndex() != 1) {
        in.readNull();
        this.id = null;
      } else {
        this.id = in.readString();
      }

      this.phase = org.radarcns.connector.oura.OuraSleepPhaseType.values()[in.readEnum()];

    } else {
      for (int i = 0; i < 4; i++) {
        switch (fieldOrder[i].pos()) {
        case 0:
          this.time = in.readDouble();
          break;

        case 1:
          this.timeReceived = in.readDouble();
          break;

        case 2:
          if (in.readIndex() != 1) {
            in.readNull();
            this.id = null;
          } else {
            this.id = in.readString();
          }
          break;

        case 3:
          this.phase = org.radarcns.connector.oura.OuraSleepPhaseType.values()[in.readEnum()];
          break;

        default:
          throw new java.io.IOException("Corrupt ResolvingDecoder.");
        }
      }
    }
  }
}














© 2015 - 2025 Weber Informatics LLC | Privacy Policy