org.openmetadata.schema.dataInsight.kpi.Kpi Maven / Gradle / Ivy
package org.openmetadata.schema.dataInsight.kpi;
import java.net.URI;
import java.util.List;
import java.util.UUID;
import javax.annotation.processing.Generated;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import org.openmetadata.schema.EntityInterface;
import org.openmetadata.schema.dataInsight.type.KpiResult;
import org.openmetadata.schema.dataInsight.type.KpiTargetType;
import org.openmetadata.schema.type.ChangeDescription;
import org.openmetadata.schema.type.EntityReference;
/**
* Kpi
*
* A `KIP` entity defines a metric and a target.
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"id",
"name",
"displayName",
"fullyQualifiedName",
"description",
"metricType",
"dataInsightChart",
"targetValue",
"kpiResult",
"startDate",
"endDate",
"owners",
"version",
"updatedAt",
"updatedBy",
"href",
"changeDescription",
"deleted",
"domain"
})
@Generated("jsonschema2pojo")
public class Kpi implements EntityInterface
{
/**
* Unique id used to identify an entity.
*
*/
@JsonProperty("id")
@JsonPropertyDescription("Unique id used to identify an entity.")
private UUID id;
/**
* Name that identifies an entity.
* (Required)
*
*/
@JsonProperty("name")
@JsonPropertyDescription("Name that identifies an entity.")
@Pattern(regexp = "^((?!::).)*$")
@Size(min = 1, max = 256)
@NotNull
private String name;
/**
* Display Name that identifies this KPI Definition.
*
*/
@JsonProperty("displayName")
@JsonPropertyDescription("Display Name that identifies this KPI Definition.")
private String displayName;
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
*
*/
@JsonProperty("fullyQualifiedName")
@JsonPropertyDescription("A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.")
@Size(min = 1, max = 3072)
private String fullyQualifiedName;
/**
* Text in Markdown format.@om-field-type
* (Required)
*
*/
@JsonProperty("description")
@JsonPropertyDescription("Text in Markdown format.")
@NotNull
private String description;
/**
* This enum defines the type of key Result
* (Required)
*
*/
@JsonProperty("metricType")
@JsonPropertyDescription("This enum defines the type of key Result")
@NotNull
private KpiTargetType metricType;
/**
* Entity Reference
*
* This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
* (Required)
*
*/
@JsonProperty("dataInsightChart")
@JsonPropertyDescription("This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.")
@Valid
@NotNull
private EntityReference dataInsightChart;
/**
* Metrics from the chart and the target to achieve the result.
* (Required)
*
*/
@JsonProperty("targetValue")
@JsonPropertyDescription("Metrics from the chart and the target to achieve the result.")
@NotNull
private Double targetValue;
/**
* Schema to capture kpi result.
*
*/
@JsonProperty("kpiResult")
@JsonPropertyDescription("Schema to capture kpi result.")
@Valid
private KpiResult kpiResult;
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
* (Required)
*
*/
@JsonProperty("startDate")
@JsonPropertyDescription("Timestamp in Unix epoch time milliseconds.")
@NotNull
private Long startDate;
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
* (Required)
*
*/
@JsonProperty("endDate")
@JsonPropertyDescription("Timestamp in Unix epoch time milliseconds.")
@NotNull
private Long endDate;
/**
* Entity Reference List
*
* This schema defines the EntityReferenceList type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
*
*/
@JsonProperty("owners")
@JsonPropertyDescription("This schema defines the EntityReferenceList type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.")
@Valid
private List owners = null;
/**
* Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.
*
*/
@JsonProperty("version")
@JsonPropertyDescription("Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.")
private Double version = 0.1D;
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
*
*/
@JsonProperty("updatedAt")
@JsonPropertyDescription("Timestamp in Unix epoch time milliseconds.")
private Long updatedAt;
/**
* User who made the update.
*
*/
@JsonProperty("updatedBy")
@JsonPropertyDescription("User who made the update.")
private String updatedBy;
/**
* URI that points to a resource.
*
*/
@JsonProperty("href")
@JsonPropertyDescription("URI that points to a resource.")
private URI href;
/**
* Description of the change.
*
*/
@JsonProperty("changeDescription")
@JsonPropertyDescription("Description of the change.")
@Valid
private ChangeDescription changeDescription;
/**
* When `true` indicates the entity has been soft deleted.
*
*/
@JsonProperty("deleted")
@JsonPropertyDescription("When `true` indicates the entity has been soft deleted.")
private Boolean deleted = false;
/**
* Entity Reference
*
* This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
*
*/
@JsonProperty("domain")
@JsonPropertyDescription("This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.")
@Valid
private EntityReference domain;
/**
* Unique id used to identify an entity.
*
*/
@JsonProperty("id")
public UUID getId() {
return id;
}
/**
* Unique id used to identify an entity.
*
*/
@JsonProperty("id")
public void setId(UUID id) {
this.id = id;
}
public Kpi withId(UUID id) {
this.id = id;
return this;
}
/**
* Name that identifies an entity.
* (Required)
*
*/
@JsonProperty("name")
public String getName() {
return name;
}
/**
* Name that identifies an entity.
* (Required)
*
*/
@JsonProperty("name")
public void setName(String name) {
this.name = name;
}
public Kpi withName(String name) {
this.name = name;
return this;
}
/**
* Display Name that identifies this KPI Definition.
*
*/
@JsonProperty("displayName")
public String getDisplayName() {
return displayName;
}
/**
* Display Name that identifies this KPI Definition.
*
*/
@JsonProperty("displayName")
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
public Kpi withDisplayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
*
*/
@JsonProperty("fullyQualifiedName")
public String getFullyQualifiedName() {
return fullyQualifiedName;
}
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
*
*/
@JsonProperty("fullyQualifiedName")
public void setFullyQualifiedName(String fullyQualifiedName) {
this.fullyQualifiedName = fullyQualifiedName;
}
public Kpi withFullyQualifiedName(String fullyQualifiedName) {
this.fullyQualifiedName = fullyQualifiedName;
return this;
}
/**
* Text in Markdown format.@om-field-type
* (Required)
*
*/
@JsonProperty("description")
public String getDescription() {
return description;
}
/**
* Text in Markdown format.@om-field-type
* (Required)
*
*/
@JsonProperty("description")
public void setDescription(String description) {
this.description = description;
}
public Kpi withDescription(String description) {
this.description = description;
return this;
}
/**
* This enum defines the type of key Result
* (Required)
*
*/
@JsonProperty("metricType")
public KpiTargetType getMetricType() {
return metricType;
}
/**
* This enum defines the type of key Result
* (Required)
*
*/
@JsonProperty("metricType")
public void setMetricType(KpiTargetType metricType) {
this.metricType = metricType;
}
public Kpi withMetricType(KpiTargetType metricType) {
this.metricType = metricType;
return this;
}
/**
* Entity Reference
*
* This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
* (Required)
*
*/
@JsonProperty("dataInsightChart")
public EntityReference getDataInsightChart() {
return dataInsightChart;
}
/**
* Entity Reference
*
* This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
* (Required)
*
*/
@JsonProperty("dataInsightChart")
public void setDataInsightChart(EntityReference dataInsightChart) {
this.dataInsightChart = dataInsightChart;
}
public Kpi withDataInsightChart(EntityReference dataInsightChart) {
this.dataInsightChart = dataInsightChart;
return this;
}
/**
* Metrics from the chart and the target to achieve the result.
* (Required)
*
*/
@JsonProperty("targetValue")
public Double getTargetValue() {
return targetValue;
}
/**
* Metrics from the chart and the target to achieve the result.
* (Required)
*
*/
@JsonProperty("targetValue")
public void setTargetValue(Double targetValue) {
this.targetValue = targetValue;
}
public Kpi withTargetValue(Double targetValue) {
this.targetValue = targetValue;
return this;
}
/**
* Schema to capture kpi result.
*
*/
@JsonProperty("kpiResult")
public KpiResult getKpiResult() {
return kpiResult;
}
/**
* Schema to capture kpi result.
*
*/
@JsonProperty("kpiResult")
public void setKpiResult(KpiResult kpiResult) {
this.kpiResult = kpiResult;
}
public Kpi withKpiResult(KpiResult kpiResult) {
this.kpiResult = kpiResult;
return this;
}
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
* (Required)
*
*/
@JsonProperty("startDate")
public Long getStartDate() {
return startDate;
}
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
* (Required)
*
*/
@JsonProperty("startDate")
public void setStartDate(Long startDate) {
this.startDate = startDate;
}
public Kpi withStartDate(Long startDate) {
this.startDate = startDate;
return this;
}
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
* (Required)
*
*/
@JsonProperty("endDate")
public Long getEndDate() {
return endDate;
}
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
* (Required)
*
*/
@JsonProperty("endDate")
public void setEndDate(Long endDate) {
this.endDate = endDate;
}
public Kpi withEndDate(Long endDate) {
this.endDate = endDate;
return this;
}
/**
* Entity Reference List
*
* This schema defines the EntityReferenceList type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
*
*/
@JsonProperty("owners")
public List getOwners() {
return owners;
}
/**
* Entity Reference List
*
* This schema defines the EntityReferenceList type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
*
*/
@JsonProperty("owners")
public void setOwners(List owners) {
this.owners = owners;
}
public Kpi withOwners(List owners) {
this.owners = owners;
return this;
}
/**
* Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.
*
*/
@JsonProperty("version")
public Double getVersion() {
return version;
}
/**
* Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.
*
*/
@JsonProperty("version")
public void setVersion(Double version) {
this.version = version;
}
public Kpi withVersion(Double version) {
this.version = version;
return this;
}
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
*
*/
@JsonProperty("updatedAt")
public Long getUpdatedAt() {
return updatedAt;
}
/**
* Timestamp in Unix epoch time milliseconds.@om-field-type
*
*/
@JsonProperty("updatedAt")
public void setUpdatedAt(Long updatedAt) {
this.updatedAt = updatedAt;
}
public Kpi withUpdatedAt(Long updatedAt) {
this.updatedAt = updatedAt;
return this;
}
/**
* User who made the update.
*
*/
@JsonProperty("updatedBy")
public String getUpdatedBy() {
return updatedBy;
}
/**
* User who made the update.
*
*/
@JsonProperty("updatedBy")
public void setUpdatedBy(String updatedBy) {
this.updatedBy = updatedBy;
}
public Kpi withUpdatedBy(String updatedBy) {
this.updatedBy = updatedBy;
return this;
}
/**
* URI that points to a resource.
*
*/
@JsonProperty("href")
public URI getHref() {
return href;
}
/**
* URI that points to a resource.
*
*/
@JsonProperty("href")
public void setHref(URI href) {
this.href = href;
}
public Kpi withHref(URI href) {
this.href = href;
return this;
}
/**
* Description of the change.
*
*/
@JsonProperty("changeDescription")
public ChangeDescription getChangeDescription() {
return changeDescription;
}
/**
* Description of the change.
*
*/
@JsonProperty("changeDescription")
public void setChangeDescription(ChangeDescription changeDescription) {
this.changeDescription = changeDescription;
}
public Kpi withChangeDescription(ChangeDescription changeDescription) {
this.changeDescription = changeDescription;
return this;
}
/**
* When `true` indicates the entity has been soft deleted.
*
*/
@JsonProperty("deleted")
public Boolean getDeleted() {
return deleted;
}
/**
* When `true` indicates the entity has been soft deleted.
*
*/
@JsonProperty("deleted")
public void setDeleted(Boolean deleted) {
this.deleted = deleted;
}
public Kpi withDeleted(Boolean deleted) {
this.deleted = deleted;
return this;
}
/**
* Entity Reference
*
* This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
*
*/
@JsonProperty("domain")
public EntityReference getDomain() {
return domain;
}
/**
* Entity Reference
*
* This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
*
*/
@JsonProperty("domain")
public void setDomain(EntityReference domain) {
this.domain = domain;
}
public Kpi withDomain(EntityReference domain) {
this.domain = domain;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(Kpi.class.getName()).append('@').append(Integer.toHexString(System.identityHashCode(this))).append('[');
sb.append("id");
sb.append('=');
sb.append(((this.id == null)?"":this.id));
sb.append(',');
sb.append("name");
sb.append('=');
sb.append(((this.name == null)?"":this.name));
sb.append(',');
sb.append("displayName");
sb.append('=');
sb.append(((this.displayName == null)?"":this.displayName));
sb.append(',');
sb.append("fullyQualifiedName");
sb.append('=');
sb.append(((this.fullyQualifiedName == null)?"":this.fullyQualifiedName));
sb.append(',');
sb.append("description");
sb.append('=');
sb.append(((this.description == null)?"":this.description));
sb.append(',');
sb.append("metricType");
sb.append('=');
sb.append(((this.metricType == null)?"":this.metricType));
sb.append(',');
sb.append("dataInsightChart");
sb.append('=');
sb.append(((this.dataInsightChart == null)?"":this.dataInsightChart));
sb.append(',');
sb.append("targetValue");
sb.append('=');
sb.append(((this.targetValue == null)?"":this.targetValue));
sb.append(',');
sb.append("kpiResult");
sb.append('=');
sb.append(((this.kpiResult == null)?"":this.kpiResult));
sb.append(',');
sb.append("startDate");
sb.append('=');
sb.append(((this.startDate == null)?"":this.startDate));
sb.append(',');
sb.append("endDate");
sb.append('=');
sb.append(((this.endDate == null)?"":this.endDate));
sb.append(',');
sb.append("owners");
sb.append('=');
sb.append(((this.owners == null)?"":this.owners));
sb.append(',');
sb.append("version");
sb.append('=');
sb.append(((this.version == null)?"":this.version));
sb.append(',');
sb.append("updatedAt");
sb.append('=');
sb.append(((this.updatedAt == null)?"":this.updatedAt));
sb.append(',');
sb.append("updatedBy");
sb.append('=');
sb.append(((this.updatedBy == null)?"":this.updatedBy));
sb.append(',');
sb.append("href");
sb.append('=');
sb.append(((this.href == null)?"":this.href));
sb.append(',');
sb.append("changeDescription");
sb.append('=');
sb.append(((this.changeDescription == null)?"":this.changeDescription));
sb.append(',');
sb.append("deleted");
sb.append('=');
sb.append(((this.deleted == null)?"":this.deleted));
sb.append(',');
sb.append("domain");
sb.append('=');
sb.append(((this.domain == null)?"":this.domain));
sb.append(',');
if (sb.charAt((sb.length()- 1)) == ',') {
sb.setCharAt((sb.length()- 1), ']');
} else {
sb.append(']');
}
return sb.toString();
}
@Override
public int hashCode() {
int result = 1;
result = ((result* 31)+((this.dataInsightChart == null)? 0 :this.dataInsightChart.hashCode()));
result = ((result* 31)+((this.updatedBy == null)? 0 :this.updatedBy.hashCode()));
result = ((result* 31)+((this.changeDescription == null)? 0 :this.changeDescription.hashCode()));
result = ((result* 31)+((this.endDate == null)? 0 :this.endDate.hashCode()));
result = ((result* 31)+((this.displayName == null)? 0 :this.displayName.hashCode()));
result = ((result* 31)+((this.description == null)? 0 :this.description.hashCode()));
result = ((result* 31)+((this.owners == null)? 0 :this.owners.hashCode()));
result = ((result* 31)+((this.fullyQualifiedName == null)? 0 :this.fullyQualifiedName.hashCode()));
result = ((result* 31)+((this.version == null)? 0 :this.version.hashCode()));
result = ((result* 31)+((this.metricType == null)? 0 :this.metricType.hashCode()));
result = ((result* 31)+((this.deleted == null)? 0 :this.deleted.hashCode()));
result = ((result* 31)+((this.domain == null)? 0 :this.domain.hashCode()));
result = ((result* 31)+((this.name == null)? 0 :this.name.hashCode()));
result = ((result* 31)+((this.targetValue == null)? 0 :this.targetValue.hashCode()));
result = ((result* 31)+((this.id == null)? 0 :this.id.hashCode()));
result = ((result* 31)+((this.href == null)? 0 :this.href.hashCode()));
result = ((result* 31)+((this.kpiResult == null)? 0 :this.kpiResult.hashCode()));
result = ((result* 31)+((this.startDate == null)? 0 :this.startDate.hashCode()));
result = ((result* 31)+((this.updatedAt == null)? 0 :this.updatedAt.hashCode()));
return result;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if ((other instanceof Kpi) == false) {
return false;
}
Kpi rhs = ((Kpi) other);
return ((((((((((((((((((((this.dataInsightChart == rhs.dataInsightChart)||((this.dataInsightChart!= null)&&this.dataInsightChart.equals(rhs.dataInsightChart)))&&((this.updatedBy == rhs.updatedBy)||((this.updatedBy!= null)&&this.updatedBy.equals(rhs.updatedBy))))&&((this.changeDescription == rhs.changeDescription)||((this.changeDescription!= null)&&this.changeDescription.equals(rhs.changeDescription))))&&((this.endDate == rhs.endDate)||((this.endDate!= null)&&this.endDate.equals(rhs.endDate))))&&((this.displayName == rhs.displayName)||((this.displayName!= null)&&this.displayName.equals(rhs.displayName))))&&((this.description == rhs.description)||((this.description!= null)&&this.description.equals(rhs.description))))&&((this.owners == rhs.owners)||((this.owners!= null)&&this.owners.equals(rhs.owners))))&&((this.fullyQualifiedName == rhs.fullyQualifiedName)||((this.fullyQualifiedName!= null)&&this.fullyQualifiedName.equals(rhs.fullyQualifiedName))))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.metricType == rhs.metricType)||((this.metricType!= null)&&this.metricType.equals(rhs.metricType))))&&((this.deleted == rhs.deleted)||((this.deleted!= null)&&this.deleted.equals(rhs.deleted))))&&((this.domain == rhs.domain)||((this.domain!= null)&&this.domain.equals(rhs.domain))))&&((this.name == rhs.name)||((this.name!= null)&&this.name.equals(rhs.name))))&&((this.targetValue == rhs.targetValue)||((this.targetValue!= null)&&this.targetValue.equals(rhs.targetValue))))&&((this.id == rhs.id)||((this.id!= null)&&this.id.equals(rhs.id))))&&((this.href == rhs.href)||((this.href!= null)&&this.href.equals(rhs.href))))&&((this.kpiResult == rhs.kpiResult)||((this.kpiResult!= null)&&this.kpiResult.equals(rhs.kpiResult))))&&((this.startDate == rhs.startDate)||((this.startDate!= null)&&this.startDate.equals(rhs.startDate))))&&((this.updatedAt == rhs.updatedAt)||((this.updatedAt!= null)&&this.updatedAt.equals(rhs.updatedAt))));
}
}