org.apache.gobblin.rest.JobExecutionQueryResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gobblin-rest-api-data-template Show documentation
A distributed data integration framework for streaming and batch data ecosystems.
The newest version!

package org.apache.gobblin.rest;

import java.util.List;
import javax.annotation.Generated;
import javax.annotation.Nonnull;
import com.linkedin.data.DataMap;
import com.linkedin.data.schema.PathSpec;
import com.linkedin.data.schema.RecordDataSchema;
import com.linkedin.data.schema.SchemaFormatType;
import com.linkedin.data.template.DataTemplateUtil;
import com.linkedin.data.template.GetMode;
import com.linkedin.data.template.RecordTemplate;
import com.linkedin.data.template.SetMode;


/**
 * Gobblin job execution query result
 * 
 */
@Generated(value = "com.linkedin.pegasus.generator.JavaCodeUtil", comments = "Rest.li Data Template. Generated from gobblin-rest-service/gobblin-rest-api/src/main/pegasus/org/apache/gobblin/rest/JobExecutionQueryResult.pdl.")
public class JobExecutionQueryResult
    extends RecordTemplate
{

    private final static JobExecutionQueryResult.Fields _fields = new JobExecutionQueryResult.Fields();
    private final static RecordDataSchema SCHEMA = ((RecordDataSchema) DataTemplateUtil.parseSchema("namespace org.apache.gobblin.rest/**Gobblin job execution query result*/record JobExecutionQueryResult{/**An array of job execution information records*/jobExecutions:array[/**Gobblin job execution information*/record JobExecutionInfo{/**Job name*/jobName:string/**Job ID*/jobId:string/**Job start time (epoch time)*/startTime:optional long/**Job end time (epoch time)*/endTime:optional long/**Job duration in milliseconds*/duration:optional long/**Job state*/state:optional enum JobStateEnum{PENDING,RUNNING,SUCCESSFUL,COMMITTED,FAILED,CANCELLED}/**Number of launched tasks*/launchedTasks:optional int/**Number of completed tasks*/completedTasks:optional int/**Job launcher type*/launcherType:optional enum LauncherTypeEnum{LOCAL,MAPREDUCE,CLUSTER,YARN}/**Job execution tracking URL*/trackingUrl:optional string/**An array of task execution information records*/taskExecutions:array[/**Gobblin task execution information*/record TaskExecutionInfo{/**Job ID*/jobId:string/**Task ID*/taskId:string/**Task start time (epoch time)*/startTime:optional long/**Task end time (epoch time)*/endTime:optional long/**Task duration in milliseconds*/duration:optional long/**Task state*/state:optional enum TaskStateEnum{PENDING,RUNNING,SUCCESSFUL,COMMITTED,FAILED,CANCELLED}/**Task failure exception message*/failureException:optional string/**Low watermark*/lowWatermark:optional long/**High watermark*/highWatermark:optional long/**Table definition*/table:optional/**Gobblin table definition*/record Table{/**Table namespace*/`namespace`:optional string/**Table name*/name:string/**Table type*/type:optional enum TableTypeEnum{SNAPSHOT_ONLY,SNAPSHOT_APPEND,APPEND_ONLY}}/**Task properties*/taskProperties:optional map[string,string]/**Job metrics*/metrics:array[/**Gobblin metric*/record Metric{/**Metric group*/group:string/**Metric name*/name:string/**Metric type*/type:enum MetricTypeEnum{COUNTER,METER,GAUGE}/**Metric value*/value:string}]}]/**Job properties*/jobProperties:optional map[string,string]/**Job metrics*/metrics:array[Metric]}]}", SchemaFormatType.PDL));
    private final static RecordDataSchema.Field FIELD_JobExecutions = SCHEMA.getField("jobExecutions");

    public JobExecutionQueryResult() {
        super(new DataMap(2, 0.75F), SCHEMA, 2);
    }

    public JobExecutionQueryResult(DataMap data) {
        super(data, SCHEMA);
    }

    public static JobExecutionQueryResult.Fields fields() {
        return _fields;
    }

    /**
     * Existence checker for jobExecutions
     * 
     * @see JobExecutionQueryResult.Fields#jobExecutions
     */
    public boolean hasJobExecutions() {
        return contains(FIELD_JobExecutions);
    }

    /**
     * Remover for jobExecutions
     * 
     * @see JobExecutionQueryResult.Fields#jobExecutions
     */
    public void removeJobExecutions() {
        remove(FIELD_JobExecutions);
    }

    /**
     * Getter for jobExecutions
     * 
     * @see JobExecutionQueryResult.Fields#jobExecutions
     */
    public JobExecutionInfoArray getJobExecutions(GetMode mode) {
        return obtainWrapped(FIELD_JobExecutions, JobExecutionInfoArray.class, mode);
    }

    /**
     * Getter for jobExecutions
     * 
     * @return
     *     Required field. Could be null for partial record.
     * @see JobExecutionQueryResult.Fields#jobExecutions
     */
    @Nonnull
    public JobExecutionInfoArray getJobExecutions() {
        return obtainWrapped(FIELD_JobExecutions, JobExecutionInfoArray.class, GetMode.STRICT);
    }

    /**
     * Setter for jobExecutions
     * 
     * @see JobExecutionQueryResult.Fields#jobExecutions
     */
    public JobExecutionQueryResult setJobExecutions(JobExecutionInfoArray value, SetMode mode) {
        putWrapped(FIELD_JobExecutions, JobExecutionInfoArray.class, value, mode);
        return this;
    }

    /**
     * Setter for jobExecutions
     * 
     * @param value
     *     Must not be null. For more control, use setters with mode instead.
     * @see JobExecutionQueryResult.Fields#jobExecutions
     */
    public JobExecutionQueryResult setJobExecutions(
        @Nonnull
        JobExecutionInfoArray value) {
        putWrapped(FIELD_JobExecutions, JobExecutionInfoArray.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    @Override
    public JobExecutionQueryResult clone()
        throws CloneNotSupportedException
    {
        return ((JobExecutionQueryResult) super.clone());
    }

    @Override
    public JobExecutionQueryResult copy()
        throws CloneNotSupportedException
    {
        return ((JobExecutionQueryResult) super.copy());
    }

    public static class Fields
        extends PathSpec
    {


        public Fields(List path, String name) {
            super(path, name);
        }

        public Fields() {
            super();
        }

        /**
         * An array of job execution information records
         * 
         */
        public org.apache.gobblin.rest.JobExecutionInfoArray.Fields jobExecutions() {
            return new org.apache.gobblin.rest.JobExecutionInfoArray.Fields(getPathComponents(), "jobExecutions");
        }

        /**
         * An array of job execution information records
         * 
         */
        public PathSpec jobExecutions(Integer start, Integer count) {
            PathSpec arrayPathSpec = new PathSpec(getPathComponents(), "jobExecutions");
            if (start!= null) {
                arrayPathSpec.setAttribute("start", start);
            }
            if (count!= null) {
                arrayPathSpec.setAttribute("count", count);
            }
            return arrayPathSpec;
        }

    }

}