org.openmetadata.schema.entity.classification.Classification Maven / Gradle / Ivy
package org.openmetadata.schema.entity.classification;
import java.net.URI;
import java.util.UUID;
import javax.annotation.processing.Generated;
import javax.validation.Valid;
import javax.validation.constraints.DecimalMin;
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.type.ChangeDescription;
import org.openmetadata.schema.type.EntityReference;
import org.openmetadata.schema.type.ProviderType;
/**
* Classification
*
* A `Classification` entity contains hierarchical terms called tags used for categorizing and classifying data assets and other entities.
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"id",
"name",
"fullyQualifiedName",
"displayName",
"description",
"version",
"termCount",
"updatedAt",
"updatedBy",
"href",
"usageCount",
"changeDescription",
"deleted",
"provider",
"disabled",
"mutuallyExclusive",
"domain"
})
@Generated("jsonschema2pojo")
public class Classification 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;
/**
* 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;
/**
* Display Name that identifies this entity.
*
*/
@JsonProperty("displayName")
@JsonPropertyDescription("Display Name that identifies this entity.")
private String displayName;
/**
* Text in Markdown format.@om-field-type
* (Required)
*
*/
@JsonProperty("description")
@JsonPropertyDescription("Text in Markdown format.")
@NotNull
private String description;
/**
* 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;
/**
* Total number of children tag terms under this classification. This includes all the children in the hierarchy.
*
*/
@JsonProperty("termCount")
@JsonPropertyDescription("Total number of children tag terms under this classification. This includes all the children in the hierarchy.")
@DecimalMin("0")
private Integer termCount;
/**
* 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;
/**
* Count of how many times the tags from this classification are used.
*
*/
@JsonProperty("usageCount")
@JsonPropertyDescription("Count of how many times the tags from this classification are used.")
private Integer usageCount;
/**
* 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;
/**
* Type of provider of an entity. Some entities are provided by the `system`. Some are entities created and provided by the `user`. Typically `system` provide entities can't be deleted and can only be disabled.
*
*/
@JsonProperty("provider")
@JsonPropertyDescription("Type of provider of an entity. Some entities are provided by the `system`. Some are entities created and provided by the `user`. Typically `system` provide entities can't be deleted and can only be disabled.")
private ProviderType provider = ProviderType.fromValue("user");
/**
* System classifications can't be deleted. Use this flag to disable them.
*
*/
@JsonProperty("disabled")
@JsonPropertyDescription("System classifications can't be deleted. Use this flag to disable them.")
private Boolean disabled;
/**
* Tags under this classification are mutually exclusive. When mutually exclusive is `true` the tags from this classification are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this classification are used to **categorize** an entity. An entity have multiple tags simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously.
*
*/
@JsonProperty("mutuallyExclusive")
@JsonPropertyDescription("Tags under this classification are mutually exclusive. When mutually exclusive is `true` the tags from this classification are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this classification are used to **categorize** an entity. An entity have multiple tags simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously.")
private Boolean mutuallyExclusive = 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 Classification 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 Classification withName(String name) {
this.name = name;
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 Classification withFullyQualifiedName(String fullyQualifiedName) {
this.fullyQualifiedName = fullyQualifiedName;
return this;
}
/**
* Display Name that identifies this entity.
*
*/
@JsonProperty("displayName")
public String getDisplayName() {
return displayName;
}
/**
* Display Name that identifies this entity.
*
*/
@JsonProperty("displayName")
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
public Classification withDisplayName(String displayName) {
this.displayName = displayName;
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 Classification withDescription(String description) {
this.description = description;
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 Classification withVersion(Double version) {
this.version = version;
return this;
}
/**
* Total number of children tag terms under this classification. This includes all the children in the hierarchy.
*
*/
@JsonProperty("termCount")
public Integer getTermCount() {
return termCount;
}
/**
* Total number of children tag terms under this classification. This includes all the children in the hierarchy.
*
*/
@JsonProperty("termCount")
public void setTermCount(Integer termCount) {
this.termCount = termCount;
}
public Classification withTermCount(Integer termCount) {
this.termCount = termCount;
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 Classification 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 Classification 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 Classification withHref(URI href) {
this.href = href;
return this;
}
/**
* Count of how many times the tags from this classification are used.
*
*/
@JsonProperty("usageCount")
public Integer getUsageCount() {
return usageCount;
}
/**
* Count of how many times the tags from this classification are used.
*
*/
@JsonProperty("usageCount")
public void setUsageCount(Integer usageCount) {
this.usageCount = usageCount;
}
public Classification withUsageCount(Integer usageCount) {
this.usageCount = usageCount;
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 Classification 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 Classification withDeleted(Boolean deleted) {
this.deleted = deleted;
return this;
}
/**
* Type of provider of an entity. Some entities are provided by the `system`. Some are entities created and provided by the `user`. Typically `system` provide entities can't be deleted and can only be disabled.
*
*/
@JsonProperty("provider")
public ProviderType getProvider() {
return provider;
}
/**
* Type of provider of an entity. Some entities are provided by the `system`. Some are entities created and provided by the `user`. Typically `system` provide entities can't be deleted and can only be disabled.
*
*/
@JsonProperty("provider")
public void setProvider(ProviderType provider) {
this.provider = provider;
}
public Classification withProvider(ProviderType provider) {
this.provider = provider;
return this;
}
/**
* System classifications can't be deleted. Use this flag to disable them.
*
*/
@JsonProperty("disabled")
public Boolean getDisabled() {
return disabled;
}
/**
* System classifications can't be deleted. Use this flag to disable them.
*
*/
@JsonProperty("disabled")
public void setDisabled(Boolean disabled) {
this.disabled = disabled;
}
public Classification withDisabled(Boolean disabled) {
this.disabled = disabled;
return this;
}
/**
* Tags under this classification are mutually exclusive. When mutually exclusive is `true` the tags from this classification are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this classification are used to **categorize** an entity. An entity have multiple tags simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously.
*
*/
@JsonProperty("mutuallyExclusive")
public Boolean getMutuallyExclusive() {
return mutuallyExclusive;
}
/**
* Tags under this classification are mutually exclusive. When mutually exclusive is `true` the tags from this classification are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this classification are used to **categorize** an entity. An entity have multiple tags simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously.
*
*/
@JsonProperty("mutuallyExclusive")
public void setMutuallyExclusive(Boolean mutuallyExclusive) {
this.mutuallyExclusive = mutuallyExclusive;
}
public Classification withMutuallyExclusive(Boolean mutuallyExclusive) {
this.mutuallyExclusive = mutuallyExclusive;
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 Classification withDomain(EntityReference domain) {
this.domain = domain;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(Classification.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("fullyQualifiedName");
sb.append('=');
sb.append(((this.fullyQualifiedName == null)?"":this.fullyQualifiedName));
sb.append(',');
sb.append("displayName");
sb.append('=');
sb.append(((this.displayName == null)?"":this.displayName));
sb.append(',');
sb.append("description");
sb.append('=');
sb.append(((this.description == null)?"":this.description));
sb.append(',');
sb.append("version");
sb.append('=');
sb.append(((this.version == null)?"":this.version));
sb.append(',');
sb.append("termCount");
sb.append('=');
sb.append(((this.termCount == null)?"":this.termCount));
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("usageCount");
sb.append('=');
sb.append(((this.usageCount == null)?"":this.usageCount));
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("provider");
sb.append('=');
sb.append(((this.provider == null)?"":this.provider));
sb.append(',');
sb.append("disabled");
sb.append('=');
sb.append(((this.disabled == null)?"":this.disabled));
sb.append(',');
sb.append("mutuallyExclusive");
sb.append('=');
sb.append(((this.mutuallyExclusive == null)?"":this.mutuallyExclusive));
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.updatedBy == null)? 0 :this.updatedBy.hashCode()));
result = ((result* 31)+((this.changeDescription == null)? 0 :this.changeDescription.hashCode()));
result = ((result* 31)+((this.displayName == null)? 0 :this.displayName.hashCode()));
result = ((result* 31)+((this.termCount == null)? 0 :this.termCount.hashCode()));
result = ((result* 31)+((this.description == null)? 0 :this.description.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.usageCount == null)? 0 :this.usageCount.hashCode()));
result = ((result* 31)+((this.deleted == null)? 0 :this.deleted.hashCode()));
result = ((result* 31)+((this.provider == null)? 0 :this.provider.hashCode()));
result = ((result* 31)+((this.mutuallyExclusive == null)? 0 :this.mutuallyExclusive.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.disabled == null)? 0 :this.disabled.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.updatedAt == null)? 0 :this.updatedAt.hashCode()));
return result;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if ((other instanceof Classification) == false) {
return false;
}
Classification rhs = ((Classification) other);
return ((((((((((((((((((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.displayName == rhs.displayName)||((this.displayName!= null)&&this.displayName.equals(rhs.displayName))))&&((this.termCount == rhs.termCount)||((this.termCount!= null)&&this.termCount.equals(rhs.termCount))))&&((this.description == rhs.description)||((this.description!= null)&&this.description.equals(rhs.description))))&&((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.usageCount == rhs.usageCount)||((this.usageCount!= null)&&this.usageCount.equals(rhs.usageCount))))&&((this.deleted == rhs.deleted)||((this.deleted!= null)&&this.deleted.equals(rhs.deleted))))&&((this.provider == rhs.provider)||((this.provider!= null)&&this.provider.equals(rhs.provider))))&&((this.mutuallyExclusive == rhs.mutuallyExclusive)||((this.mutuallyExclusive!= null)&&this.mutuallyExclusive.equals(rhs.mutuallyExclusive))))&&((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.disabled == rhs.disabled)||((this.disabled!= null)&&this.disabled.equals(rhs.disabled))))&&((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.updatedAt == rhs.updatedAt)||((this.updatedAt!= null)&&this.updatedAt.equals(rhs.updatedAt))));
}
}