gobblin.service.FlowStatus Maven / Gradle / Ivy
The newest version!
package gobblin.service;
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.template.DataTemplateUtil;
import com.linkedin.data.template.GetMode;
import com.linkedin.data.template.RecordTemplate;
import com.linkedin.data.template.SetMode;
/**
* Status of a flow
*
*/
@Generated(value = "com.linkedin.pegasus.generator.JavaCodeUtil", comments = "Rest.li Data Template. Generated from /Users/ibuenros/repos/gobblin/gobblin-restli/gobblin-flow-config-service/gobblin-flow-config-service-api/src/main/pegasus/gobblin/service/FlowStatus.pdsc.", date = "Fri Jul 21 13:35:27 PDT 2017")
public class FlowStatus
extends RecordTemplate
{
private final static FlowStatus.Fields _fields = new FlowStatus.Fields();
private final static RecordDataSchema SCHEMA = ((RecordDataSchema) DataTemplateUtil.parseSchema("{\"type\":\"record\",\"name\":\"FlowStatus\",\"namespace\":\"gobblin.service\",\"doc\":\"Status of a flow\",\"fields\":[{\"name\":\"id\",\"type\":{\"type\":\"record\",\"name\":\"FlowStatusId\",\"doc\":\"Identifier for a specific execution of a flow\",\"fields\":[{\"name\":\"flowName\",\"type\":\"string\",\"doc\":\"Name of the flow\"},{\"name\":\"flowGroup\",\"type\":\"string\",\"doc\":\"Group of the flow. This defines the namespace for the flow.\"},{\"name\":\"flowExecutionId\",\"type\":\"long\",\"doc\":\"Execution id for the flow\"}]},\"doc\":\"Flow status identifier\"},{\"name\":\"executionStatistics\",\"type\":{\"type\":\"record\",\"name\":\"FlowStatistics\",\"doc\":\"Statistics from a flow execution\",\"fields\":[{\"name\":\"executionStartTime\",\"type\":\"long\",\"doc\":\"Epoch time of when the execution began\"},{\"name\":\"executionEndTime\",\"type\":\"long\",\"doc\":\"Epoch time of when the execution ended\"}]},\"doc\":\"Statistics for this execution of the flow\"},{\"name\":\"executionStatus\",\"type\":{\"type\":\"enum\",\"name\":\"ExecutionStatus\",\"doc\":\"Execution status for a flow or job\",\"symbols\":[\"RUNNING\",\"FAILED\",\"COMPLETE\"],\"symbolDocs\":{\"RUNNING\":\"Flow or job is currently executing\",\"FAILED\":\"Flow or job failed\",\"COMPLETE\":\"Flow or job completed execution\"}},\"doc\":\"Flow execution status\"},{\"name\":\"message\",\"type\":\"string\",\"doc\":\"Error or status message\"},{\"name\":\"jobStatuses\",\"type\":{\"type\":\"array\",\"items\":{\"type\":\"record\",\"name\":\"JobStatus\",\"doc\":\"Execution status for a job\",\"fields\":[{\"name\":\"flowId\",\"type\":{\"type\":\"record\",\"name\":\"FlowId\",\"doc\":\"Identifier for a Gobblin as a Service flow\",\"fields\":[{\"name\":\"flowName\",\"type\":\"string\",\"doc\":\"Name of the flow\",\"validate\":{\"strlen\":{\"min\":1,\"max\":128}}},{\"name\":\"flowGroup\",\"type\":\"string\",\"doc\":\"Group of the flow. This defines the namespace for the flow.\",\"validate\":{\"strlen\":{\"min\":1,\"max\":128}}}]},\"doc\":\"Identifier of the flow the job belongs to\"},{\"name\":\"jobId\",\"type\":{\"type\":\"record\",\"name\":\"JobId\",\"doc\":\"Identifier for a Gobblin job\",\"fields\":[{\"name\":\"jobName\",\"type\":\"string\",\"doc\":\"Name of the job\",\"validate\":{\"strlen\":{\"min\":1,\"max\":128}}},{\"name\":\"jobGroup\",\"type\":\"string\",\"doc\":\"Group of the job. This defines the namespace for the job.\",\"validate\":{\"strlen\":{\"min\":1,\"max\":128}}}]},\"doc\":\"Identifier of the job\"},{\"name\":\"executionStatus\",\"type\":\"ExecutionStatus\",\"doc\":\"Job execution status\"},{\"name\":\"message\",\"type\":\"string\",\"doc\":\"Error or status message\"},{\"name\":\"executionStatistics\",\"type\":{\"type\":\"record\",\"name\":\"JobStatistics\",\"doc\":\"Statistics from a job execution\",\"fields\":[{\"name\":\"executionStartTime\",\"type\":\"long\",\"doc\":\"Epoch time of when the execution began\"},{\"name\":\"executionEndTime\",\"type\":\"long\",\"doc\":\"Epoch time of when the execution ended\"},{\"name\":\"processedCount\",\"type\":\"long\",\"doc\":\"number of records processed in the last job execution\"}]},\"doc\":\"Statistics from the job execution. The values may be updated during the run of a job.\"},{\"name\":\"jobState\",\"type\":{\"type\":\"record\",\"name\":\"JobState\",\"doc\":\"Job state that is updated at the end of an execution\",\"fields\":[{\"name\":\"lowWatermark\",\"type\":\"string\",\"doc\":\"Low watermark after last execution\"},{\"name\":\"highWatermark\",\"type\":\"string\",\"doc\":\"High watermark after last execution\"}]},\"doc\":\"Job state that is updated only at the start and end of a job execution.\"}]}},\"doc\":\"Status of jobs belonging to the flow\"}]}"));
private final static RecordDataSchema.Field FIELD_Id = SCHEMA.getField("id");
private final static RecordDataSchema.Field FIELD_ExecutionStatistics = SCHEMA.getField("executionStatistics");
private final static RecordDataSchema.Field FIELD_ExecutionStatus = SCHEMA.getField("executionStatus");
private final static RecordDataSchema.Field FIELD_Message = SCHEMA.getField("message");
private final static RecordDataSchema.Field FIELD_JobStatuses = SCHEMA.getField("jobStatuses");
public FlowStatus() {
super(new DataMap(), SCHEMA);
}
public FlowStatus(DataMap data) {
super(data, SCHEMA);
}
public static FlowStatus.Fields fields() {
return _fields;
}
/**
* Existence checker for id
*
* @see FlowStatus.Fields#id
*/
public boolean hasId() {
return contains(FIELD_Id);
}
/**
* Remover for id
*
* @see FlowStatus.Fields#id
*/
public void removeId() {
remove(FIELD_Id);
}
/**
* Getter for id
*
* @see FlowStatus.Fields#id
*/
public FlowStatusId getId(GetMode mode) {
return obtainWrapped(FIELD_Id, FlowStatusId.class, mode);
}
/**
* Getter for id
*
* @return
* Required field. Could be null for partial record.
* @see FlowStatus.Fields#id
*/
@Nonnull
public FlowStatusId getId() {
return obtainWrapped(FIELD_Id, FlowStatusId.class, GetMode.STRICT);
}
/**
* Setter for id
*
* @see FlowStatus.Fields#id
*/
public FlowStatus setId(FlowStatusId value, SetMode mode) {
putWrapped(FIELD_Id, FlowStatusId.class, value, mode);
return this;
}
/**
* Setter for id
*
* @param value
* Must not be null. For more control, use setters with mode instead.
* @see FlowStatus.Fields#id
*/
public FlowStatus setId(
@Nonnull
FlowStatusId value) {
putWrapped(FIELD_Id, FlowStatusId.class, value, SetMode.DISALLOW_NULL);
return this;
}
/**
* Existence checker for executionStatistics
*
* @see FlowStatus.Fields#executionStatistics
*/
public boolean hasExecutionStatistics() {
return contains(FIELD_ExecutionStatistics);
}
/**
* Remover for executionStatistics
*
* @see FlowStatus.Fields#executionStatistics
*/
public void removeExecutionStatistics() {
remove(FIELD_ExecutionStatistics);
}
/**
* Getter for executionStatistics
*
* @see FlowStatus.Fields#executionStatistics
*/
public FlowStatistics getExecutionStatistics(GetMode mode) {
return obtainWrapped(FIELD_ExecutionStatistics, FlowStatistics.class, mode);
}
/**
* Getter for executionStatistics
*
* @return
* Required field. Could be null for partial record.
* @see FlowStatus.Fields#executionStatistics
*/
@Nonnull
public FlowStatistics getExecutionStatistics() {
return obtainWrapped(FIELD_ExecutionStatistics, FlowStatistics.class, GetMode.STRICT);
}
/**
* Setter for executionStatistics
*
* @see FlowStatus.Fields#executionStatistics
*/
public FlowStatus setExecutionStatistics(FlowStatistics value, SetMode mode) {
putWrapped(FIELD_ExecutionStatistics, FlowStatistics.class, value, mode);
return this;
}
/**
* Setter for executionStatistics
*
* @param value
* Must not be null. For more control, use setters with mode instead.
* @see FlowStatus.Fields#executionStatistics
*/
public FlowStatus setExecutionStatistics(
@Nonnull
FlowStatistics value) {
putWrapped(FIELD_ExecutionStatistics, FlowStatistics.class, value, SetMode.DISALLOW_NULL);
return this;
}
/**
* Existence checker for executionStatus
*
* @see FlowStatus.Fields#executionStatus
*/
public boolean hasExecutionStatus() {
return contains(FIELD_ExecutionStatus);
}
/**
* Remover for executionStatus
*
* @see FlowStatus.Fields#executionStatus
*/
public void removeExecutionStatus() {
remove(FIELD_ExecutionStatus);
}
/**
* Getter for executionStatus
*
* @see FlowStatus.Fields#executionStatus
*/
public ExecutionStatus getExecutionStatus(GetMode mode) {
return obtainDirect(FIELD_ExecutionStatus, ExecutionStatus.class, mode);
}
/**
* Getter for executionStatus
*
* @return
* Required field. Could be null for partial record.
* @see FlowStatus.Fields#executionStatus
*/
@Nonnull
public ExecutionStatus getExecutionStatus() {
return obtainDirect(FIELD_ExecutionStatus, ExecutionStatus.class, GetMode.STRICT);
}
/**
* Setter for executionStatus
*
* @see FlowStatus.Fields#executionStatus
*/
public FlowStatus setExecutionStatus(ExecutionStatus value, SetMode mode) {
putDirect(FIELD_ExecutionStatus, ExecutionStatus.class, String.class, value, mode);
return this;
}
/**
* Setter for executionStatus
*
* @param value
* Must not be null. For more control, use setters with mode instead.
* @see FlowStatus.Fields#executionStatus
*/
public FlowStatus setExecutionStatus(
@Nonnull
ExecutionStatus value) {
putDirect(FIELD_ExecutionStatus, ExecutionStatus.class, String.class, value, SetMode.DISALLOW_NULL);
return this;
}
/**
* Existence checker for message
*
* @see FlowStatus.Fields#message
*/
public boolean hasMessage() {
return contains(FIELD_Message);
}
/**
* Remover for message
*
* @see FlowStatus.Fields#message
*/
public void removeMessage() {
remove(FIELD_Message);
}
/**
* Getter for message
*
* @see FlowStatus.Fields#message
*/
public String getMessage(GetMode mode) {
return obtainDirect(FIELD_Message, String.class, mode);
}
/**
* Getter for message
*
* @return
* Required field. Could be null for partial record.
* @see FlowStatus.Fields#message
*/
@Nonnull
public String getMessage() {
return obtainDirect(FIELD_Message, String.class, GetMode.STRICT);
}
/**
* Setter for message
*
* @see FlowStatus.Fields#message
*/
public FlowStatus setMessage(String value, SetMode mode) {
putDirect(FIELD_Message, String.class, String.class, value, mode);
return this;
}
/**
* Setter for message
*
* @param value
* Must not be null. For more control, use setters with mode instead.
* @see FlowStatus.Fields#message
*/
public FlowStatus setMessage(
@Nonnull
String value) {
putDirect(FIELD_Message, String.class, String.class, value, SetMode.DISALLOW_NULL);
return this;
}
/**
* Existence checker for jobStatuses
*
* @see FlowStatus.Fields#jobStatuses
*/
public boolean hasJobStatuses() {
return contains(FIELD_JobStatuses);
}
/**
* Remover for jobStatuses
*
* @see FlowStatus.Fields#jobStatuses
*/
public void removeJobStatuses() {
remove(FIELD_JobStatuses);
}
/**
* Getter for jobStatuses
*
* @see FlowStatus.Fields#jobStatuses
*/
public JobStatusArray getJobStatuses(GetMode mode) {
return obtainWrapped(FIELD_JobStatuses, JobStatusArray.class, mode);
}
/**
* Getter for jobStatuses
*
* @return
* Required field. Could be null for partial record.
* @see FlowStatus.Fields#jobStatuses
*/
@Nonnull
public JobStatusArray getJobStatuses() {
return obtainWrapped(FIELD_JobStatuses, JobStatusArray.class, GetMode.STRICT);
}
/**
* Setter for jobStatuses
*
* @see FlowStatus.Fields#jobStatuses
*/
public FlowStatus setJobStatuses(JobStatusArray value, SetMode mode) {
putWrapped(FIELD_JobStatuses, JobStatusArray.class, value, mode);
return this;
}
/**
* Setter for jobStatuses
*
* @param value
* Must not be null. For more control, use setters with mode instead.
* @see FlowStatus.Fields#jobStatuses
*/
public FlowStatus setJobStatuses(
@Nonnull
JobStatusArray value) {
putWrapped(FIELD_JobStatuses, JobStatusArray.class, value, SetMode.DISALLOW_NULL);
return this;
}
@Override
public FlowStatus clone()
throws CloneNotSupportedException
{
return ((FlowStatus) super.clone());
}
@Override
public FlowStatus copy()
throws CloneNotSupportedException
{
return ((FlowStatus) super.copy());
}
public static class Fields
extends PathSpec
{
public Fields(List path, String name) {
super(path, name);
}
public Fields() {
super();
}
/**
* Flow status identifier
*
*/
public gobblin.service.FlowStatusId.Fields id() {
return new gobblin.service.FlowStatusId.Fields(getPathComponents(), "id");
}
/**
* Statistics for this execution of the flow
*
*/
public gobblin.service.FlowStatistics.Fields executionStatistics() {
return new gobblin.service.FlowStatistics.Fields(getPathComponents(), "executionStatistics");
}
/**
* Flow execution status
*
*/
public PathSpec executionStatus() {
return new PathSpec(getPathComponents(), "executionStatus");
}
/**
* Error or status message
*
*/
public PathSpec message() {
return new PathSpec(getPathComponents(), "message");
}
/**
* Status of jobs belonging to the flow
*
*/
public gobblin.service.JobStatusArray.Fields jobStatuses() {
return new gobblin.service.JobStatusArray.Fields(getPathComponents(), "jobStatuses");
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy