com.twitter.ambrose.model.Job Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ambrose-common Show documentation
There is a newer version: 0.4.3
/*
Copyright 2012 Twitter, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.twitter.ambrose.model;


import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.core.type.TypeReference;
import com.google.common.base.Objects;

import com.twitter.ambrose.util.JSONUtil;

import java.io.IOException;
import java.util.Map;
import java.util.Properties;

/**
 * Class that encapsulates all information related to a run of a job. A job might have job
 * configuration and job metric data. Job metrics represents job data that is produced after the
 * conclusion of a job.
 *
 * @author billg
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "runtime")
@JsonSubTypes({
    @JsonSubTypes.Type(value=com.twitter.ambrose.model.Job.class, name="default")
})
public class Job {
  private String id;
  private Properties configuration;
  private Map metrics;

  protected Job() { }

  @JsonCreator
  public Job(@JsonProperty("id") String id,
      @JsonProperty("configuration") Properties configuration,
      @JsonProperty("metrics") Map metrics) {
    this.id = id;
    this.metrics = metrics;
    this.configuration = configuration;
  }

  public String getId() { return id; }
  public void setId(String id) { this.id = id; }

  public Properties getConfiguration() { return configuration; }
  public void setConfiguration(Properties configuration) { this.configuration = configuration; }

  public Map getMetrics() { return metrics; }
  protected void setMetrics(Map metrics) { this.metrics = metrics; }

  @Override
  public int hashCode() {
    return Objects.hashCode(id, configuration, metrics);
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    if (obj == this) {
      return true;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    Job that = (Job) obj;
    return Objects.equal(id, that.id)
        && Objects.equal(configuration, that.configuration)
        && Objects.equal(metrics, that.metrics);
  }

  public String toJson() throws IOException {
    return JSONUtil.toJson(this);
  }

  public static Job fromJson(String json) throws IOException {
    return JSONUtil.toObject(json, new TypeReference() { });
  }
}