org.openmetadata.schema.entity.data.GlossaryTerm Maven / Gradle / Ivy
package org.openmetadata.schema.entity.data;
import java.net.URI;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.JsonCreator;
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 com.fasterxml.jackson.annotation.JsonValue;
import org.openmetadata.schema.EntityInterface;
import org.openmetadata.schema.api.data.TermReference;
import org.openmetadata.schema.entity.type.Style;
import org.openmetadata.schema.type.ChangeDescription;
import org.openmetadata.schema.type.EntityReference;
import org.openmetadata.schema.type.ProviderType;
import org.openmetadata.schema.type.TagLabel;
import org.openmetadata.schema.type.Votes;
/**
* GlossaryTerm
*
* This schema defines te Glossary term entities.@om-entity-type
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"id",
"name",
"displayName",
"description",
"style",
"fullyQualifiedName",
"synonyms",
"glossary",
"parent",
"children",
"relatedTerms",
"references",
"version",
"updatedAt",
"updatedBy",
"href",
"reviewers",
"owners",
"usageCount",
"tags",
"changeDescription",
"status",
"deleted",
"provider",
"disabled",
"mutuallyExclusive",
"extension",
"domain",
"dataProducts",
"votes",
"childrenCount"
})
@Generated("jsonschema2pojo")
public class GlossaryTerm implements EntityInterface
{
/**
* Unique id used to identify an entity.
* (Required)
*
*/
@JsonProperty("id")
@JsonPropertyDescription("Unique id used to identify an entity.")
@NotNull
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 glossary.
*
*/
@JsonProperty("displayName")
@JsonPropertyDescription("Display Name that identifies this glossary.")
private String displayName;
/**
* Text in Markdown format.@om-field-type
* (Required)
*
*/
@JsonProperty("description")
@JsonPropertyDescription("Text in Markdown format.")
@NotNull
private String description;
/**
* UI Style is used to associate a color code and/or icon to entity to customize the look of that entity in UI.
*
*/
@JsonProperty("style")
@JsonPropertyDescription("UI Style is used to associate a color code and/or icon to entity to customize the look of that entity in UI.")
@Valid
private Style style;
/**
* 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;
/**
* Alternate names that are synonyms or near-synonyms for the glossary term.
*
*/
@JsonProperty("synonyms")
@JsonPropertyDescription("Alternate names that are synonyms or near-synonyms for the glossary term.")
@Valid
private List synonyms = new ArrayList();
/**
* 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("glossary")
@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 glossary;
/**
* 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("parent")
@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 parent;
/**
* 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("children")
@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 children = null;
/**
* 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("relatedTerms")
@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 relatedTerms = null;
/**
* Link to a reference from an external glossary.
*
*/
@JsonProperty("references")
@JsonPropertyDescription("Link to a reference from an external glossary.")
@Valid
private List references = new ArrayList();
/**
* 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;
/**
* 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("reviewers")
@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 reviewers = null;
/**
* 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;
/**
* Count of how many times this and it's children glossary terms are used as labels.
*
*/
@JsonProperty("usageCount")
@JsonPropertyDescription("Count of how many times this and it's children glossary terms are used as labels.")
private Integer usageCount;
/**
* Tags associated with this glossary term. These tags captures relationship of a glossary term with a tag automatically. As an example a glossary term 'User.PhoneNumber' might have an associated tag 'PII.Sensitive'. When 'User.Address' is used to label a column in a table, 'PII.Sensitive' label is also applied automatically due to Associated tag relationship.
*
*/
@JsonProperty("tags")
@JsonPropertyDescription("Tags associated with this glossary term. These tags captures relationship of a glossary term with a tag automatically. As an example a glossary term 'User.PhoneNumber' might have an associated tag 'PII.Sensitive'. When 'User.Address' is used to label a column in a table, 'PII.Sensitive' label is also applied automatically due to Associated tag relationship.")
@Valid
private List tags = new ArrayList();
/**
* Description of the change.
*
*/
@JsonProperty("changeDescription")
@JsonPropertyDescription("Description of the change.")
@Valid
private ChangeDescription changeDescription;
@JsonProperty("status")
private GlossaryTerm.Status status;
/**
* 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 glossary can't be deleted. Use this flag to disable them.
*
*/
@JsonProperty("disabled")
@JsonPropertyDescription("System glossary can't be deleted. Use this flag to disable them.")
private Boolean disabled;
/**
* Glossary terms that are children of this term are mutually exclusive. When mutually exclusive is `true` only one term can be used to label an entity from this group. When mutually exclusive is `false`, multiple terms from this group can be used to label an entity.
*
*/
@JsonProperty("mutuallyExclusive")
@JsonPropertyDescription("Glossary terms that are children of this term are mutually exclusive. When mutually exclusive is `true` only one term can be used to label an entity from this group. When mutually exclusive is `false`, multiple terms from this group can be used to label an entity.")
private Boolean mutuallyExclusive = false;
/**
* Entity extension data with custom attributes added to the entity.
*
*/
@JsonProperty("extension")
@JsonPropertyDescription("Entity extension data with custom attributes added to the entity.")
private Object extension;
/**
* 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;
/**
* 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("dataProducts")
@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 dataProducts = null;
/**
* Votes
*
* This schema defines the Votes for a Data Asset.
*
*/
@JsonProperty("votes")
@JsonPropertyDescription("This schema defines the Votes for a Data Asset.")
@Valid
private Votes votes;
/**
* Count of immediate children glossary terms.
*
*/
@JsonProperty("childrenCount")
@JsonPropertyDescription("Count of immediate children glossary terms.")
private Integer childrenCount;
/**
* Unique id used to identify an entity.
* (Required)
*
*/
@JsonProperty("id")
public UUID getId() {
return id;
}
/**
* Unique id used to identify an entity.
* (Required)
*
*/
@JsonProperty("id")
public void setId(UUID id) {
this.id = id;
}
public GlossaryTerm 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 GlossaryTerm withName(String name) {
this.name = name;
return this;
}
/**
* Display Name that identifies this glossary.
*
*/
@JsonProperty("displayName")
public String getDisplayName() {
return displayName;
}
/**
* Display Name that identifies this glossary.
*
*/
@JsonProperty("displayName")
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
public GlossaryTerm 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 GlossaryTerm withDescription(String description) {
this.description = description;
return this;
}
/**
* UI Style is used to associate a color code and/or icon to entity to customize the look of that entity in UI.
*
*/
@JsonProperty("style")
public Style getStyle() {
return style;
}
/**
* UI Style is used to associate a color code and/or icon to entity to customize the look of that entity in UI.
*
*/
@JsonProperty("style")
public void setStyle(Style style) {
this.style = style;
}
public GlossaryTerm withStyle(Style style) {
this.style = style;
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 GlossaryTerm withFullyQualifiedName(String fullyQualifiedName) {
this.fullyQualifiedName = fullyQualifiedName;
return this;
}
/**
* Alternate names that are synonyms or near-synonyms for the glossary term.
*
*/
@JsonProperty("synonyms")
public List getSynonyms() {
return synonyms;
}
/**
* Alternate names that are synonyms or near-synonyms for the glossary term.
*
*/
@JsonProperty("synonyms")
public void setSynonyms(List synonyms) {
this.synonyms = synonyms;
}
public GlossaryTerm withSynonyms(List synonyms) {
this.synonyms = synonyms;
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("glossary")
public EntityReference getGlossary() {
return glossary;
}
/**
* 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("glossary")
public void setGlossary(EntityReference glossary) {
this.glossary = glossary;
}
public GlossaryTerm withGlossary(EntityReference glossary) {
this.glossary = glossary;
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("parent")
public EntityReference getParent() {
return parent;
}
/**
* 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("parent")
public void setParent(EntityReference parent) {
this.parent = parent;
}
public GlossaryTerm withParent(EntityReference parent) {
this.parent = parent;
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("children")
public List getChildren() {
return children;
}
/**
* 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("children")
public void setChildren(List children) {
this.children = children;
}
public GlossaryTerm withChildren(List children) {
this.children = children;
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("relatedTerms")
public List getRelatedTerms() {
return relatedTerms;
}
/**
* 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("relatedTerms")
public void setRelatedTerms(List relatedTerms) {
this.relatedTerms = relatedTerms;
}
public GlossaryTerm withRelatedTerms(List relatedTerms) {
this.relatedTerms = relatedTerms;
return this;
}
/**
* Link to a reference from an external glossary.
*
*/
@JsonProperty("references")
public List getReferences() {
return references;
}
/**
* Link to a reference from an external glossary.
*
*/
@JsonProperty("references")
public void setReferences(List references) {
this.references = references;
}
public GlossaryTerm withReferences(List references) {
this.references = references;
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 GlossaryTerm 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 GlossaryTerm 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 GlossaryTerm 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 GlossaryTerm withHref(URI href) {
this.href = href;
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("reviewers")
public List getReviewers() {
return reviewers;
}
/**
* 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("reviewers")
public void setReviewers(List reviewers) {
this.reviewers = reviewers;
}
public GlossaryTerm withReviewers(List reviewers) {
this.reviewers = reviewers;
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 GlossaryTerm withOwners(List owners) {
this.owners = owners;
return this;
}
/**
* Count of how many times this and it's children glossary terms are used as labels.
*
*/
@JsonProperty("usageCount")
public Integer getUsageCount() {
return usageCount;
}
/**
* Count of how many times this and it's children glossary terms are used as labels.
*
*/
@JsonProperty("usageCount")
public void setUsageCount(Integer usageCount) {
this.usageCount = usageCount;
}
public GlossaryTerm withUsageCount(Integer usageCount) {
this.usageCount = usageCount;
return this;
}
/**
* Tags associated with this glossary term. These tags captures relationship of a glossary term with a tag automatically. As an example a glossary term 'User.PhoneNumber' might have an associated tag 'PII.Sensitive'. When 'User.Address' is used to label a column in a table, 'PII.Sensitive' label is also applied automatically due to Associated tag relationship.
*
*/
@JsonProperty("tags")
public List getTags() {
return tags;
}
/**
* Tags associated with this glossary term. These tags captures relationship of a glossary term with a tag automatically. As an example a glossary term 'User.PhoneNumber' might have an associated tag 'PII.Sensitive'. When 'User.Address' is used to label a column in a table, 'PII.Sensitive' label is also applied automatically due to Associated tag relationship.
*
*/
@JsonProperty("tags")
public void setTags(List tags) {
this.tags = tags;
}
public GlossaryTerm withTags(List tags) {
this.tags = tags;
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 GlossaryTerm withChangeDescription(ChangeDescription changeDescription) {
this.changeDescription = changeDescription;
return this;
}
@JsonProperty("status")
public GlossaryTerm.Status getStatus() {
return status;
}
@JsonProperty("status")
public void setStatus(GlossaryTerm.Status status) {
this.status = status;
}
public GlossaryTerm withStatus(GlossaryTerm.Status status) {
this.status = status;
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 GlossaryTerm 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 GlossaryTerm withProvider(ProviderType provider) {
this.provider = provider;
return this;
}
/**
* System glossary can't be deleted. Use this flag to disable them.
*
*/
@JsonProperty("disabled")
public Boolean getDisabled() {
return disabled;
}
/**
* System glossary can't be deleted. Use this flag to disable them.
*
*/
@JsonProperty("disabled")
public void setDisabled(Boolean disabled) {
this.disabled = disabled;
}
public GlossaryTerm withDisabled(Boolean disabled) {
this.disabled = disabled;
return this;
}
/**
* Glossary terms that are children of this term are mutually exclusive. When mutually exclusive is `true` only one term can be used to label an entity from this group. When mutually exclusive is `false`, multiple terms from this group can be used to label an entity.
*
*/
@JsonProperty("mutuallyExclusive")
public Boolean getMutuallyExclusive() {
return mutuallyExclusive;
}
/**
* Glossary terms that are children of this term are mutually exclusive. When mutually exclusive is `true` only one term can be used to label an entity from this group. When mutually exclusive is `false`, multiple terms from this group can be used to label an entity.
*
*/
@JsonProperty("mutuallyExclusive")
public void setMutuallyExclusive(Boolean mutuallyExclusive) {
this.mutuallyExclusive = mutuallyExclusive;
}
public GlossaryTerm withMutuallyExclusive(Boolean mutuallyExclusive) {
this.mutuallyExclusive = mutuallyExclusive;
return this;
}
/**
* Entity extension data with custom attributes added to the entity.
*
*/
@JsonProperty("extension")
public Object getExtension() {
return extension;
}
/**
* Entity extension data with custom attributes added to the entity.
*
*/
@JsonProperty("extension")
public void setExtension(Object extension) {
this.extension = extension;
}
public GlossaryTerm withExtension(Object extension) {
this.extension = extension;
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 GlossaryTerm withDomain(EntityReference domain) {
this.domain = domain;
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("dataProducts")
public List getDataProducts() {
return dataProducts;
}
/**
* 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("dataProducts")
public void setDataProducts(List dataProducts) {
this.dataProducts = dataProducts;
}
public GlossaryTerm withDataProducts(List dataProducts) {
this.dataProducts = dataProducts;
return this;
}
/**
* Votes
*
* This schema defines the Votes for a Data Asset.
*
*/
@JsonProperty("votes")
public Votes getVotes() {
return votes;
}
/**
* Votes
*
* This schema defines the Votes for a Data Asset.
*
*/
@JsonProperty("votes")
public void setVotes(Votes votes) {
this.votes = votes;
}
public GlossaryTerm withVotes(Votes votes) {
this.votes = votes;
return this;
}
/**
* Count of immediate children glossary terms.
*
*/
@JsonProperty("childrenCount")
public Integer getChildrenCount() {
return childrenCount;
}
/**
* Count of immediate children glossary terms.
*
*/
@JsonProperty("childrenCount")
public void setChildrenCount(Integer childrenCount) {
this.childrenCount = childrenCount;
}
public GlossaryTerm withChildrenCount(Integer childrenCount) {
this.childrenCount = childrenCount;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(GlossaryTerm.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("description");
sb.append('=');
sb.append(((this.description == null)?"":this.description));
sb.append(',');
sb.append("style");
sb.append('=');
sb.append(((this.style == null)?"":this.style));
sb.append(',');
sb.append("fullyQualifiedName");
sb.append('=');
sb.append(((this.fullyQualifiedName == null)?"":this.fullyQualifiedName));
sb.append(',');
sb.append("synonyms");
sb.append('=');
sb.append(((this.synonyms == null)?"":this.synonyms));
sb.append(',');
sb.append("glossary");
sb.append('=');
sb.append(((this.glossary == null)?"":this.glossary));
sb.append(',');
sb.append("parent");
sb.append('=');
sb.append(((this.parent == null)?"":this.parent));
sb.append(',');
sb.append("children");
sb.append('=');
sb.append(((this.children == null)?"":this.children));
sb.append(',');
sb.append("relatedTerms");
sb.append('=');
sb.append(((this.relatedTerms == null)?"":this.relatedTerms));
sb.append(',');
sb.append("references");
sb.append('=');
sb.append(((this.references == null)?"":this.references));
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("reviewers");
sb.append('=');
sb.append(((this.reviewers == null)?"":this.reviewers));
sb.append(',');
sb.append("owners");
sb.append('=');
sb.append(((this.owners == null)?"":this.owners));
sb.append(',');
sb.append("usageCount");
sb.append('=');
sb.append(((this.usageCount == null)?"":this.usageCount));
sb.append(',');
sb.append("tags");
sb.append('=');
sb.append(((this.tags == null)?"":this.tags));
sb.append(',');
sb.append("changeDescription");
sb.append('=');
sb.append(((this.changeDescription == null)?"":this.changeDescription));
sb.append(',');
sb.append("status");
sb.append('=');
sb.append(((this.status == null)?"":this.status));
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("extension");
sb.append('=');
sb.append(((this.extension == null)?"":this.extension));
sb.append(',');
sb.append("domain");
sb.append('=');
sb.append(((this.domain == null)?"":this.domain));
sb.append(',');
sb.append("dataProducts");
sb.append('=');
sb.append(((this.dataProducts == null)?"":this.dataProducts));
sb.append(',');
sb.append("votes");
sb.append('=');
sb.append(((this.votes == null)?"":this.votes));
sb.append(',');
sb.append("childrenCount");
sb.append('=');
sb.append(((this.childrenCount == null)?"":this.childrenCount));
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.parent == null)? 0 :this.parent.hashCode()));
result = ((result* 31)+((this.extension == null)? 0 :this.extension.hashCode()));
result = ((result* 31)+((this.references == null)? 0 :this.references.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.relatedTerms == null)? 0 :this.relatedTerms.hashCode()));
result = ((result* 31)+((this.children == null)? 0 :this.children.hashCode()));
result = ((result* 31)+((this.provider == null)? 0 :this.provider.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()));
result = ((result* 31)+((this.childrenCount == null)? 0 :this.childrenCount.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.synonyms == null)? 0 :this.synonyms.hashCode()));
result = ((result* 31)+((this.dataProducts == null)? 0 :this.dataProducts.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.reviewers == null)? 0 :this.reviewers.hashCode()));
result = ((result* 31)+((this.usageCount == null)? 0 :this.usageCount.hashCode()));
result = ((result* 31)+((this.tags == null)? 0 :this.tags.hashCode()));
result = ((result* 31)+((this.glossary == null)? 0 :this.glossary.hashCode()));
result = ((result* 31)+((this.deleted == null)? 0 :this.deleted.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.style == null)? 0 :this.style.hashCode()));
result = ((result* 31)+((this.votes == null)? 0 :this.votes.hashCode()));
result = ((result* 31)+((this.status == null)? 0 :this.status.hashCode()));
return result;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if ((other instanceof GlossaryTerm) == false) {
return false;
}
GlossaryTerm rhs = ((GlossaryTerm) other);
return ((((((((((((((((((((((((((((((((this.parent == rhs.parent)||((this.parent!= null)&&this.parent.equals(rhs.parent)))&&((this.extension == rhs.extension)||((this.extension!= null)&&this.extension.equals(rhs.extension))))&&((this.references == rhs.references)||((this.references!= null)&&this.references.equals(rhs.references))))&&((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.relatedTerms == rhs.relatedTerms)||((this.relatedTerms!= null)&&this.relatedTerms.equals(rhs.relatedTerms))))&&((this.children == rhs.children)||((this.children!= null)&&this.children.equals(rhs.children))))&&((this.provider == rhs.provider)||((this.provider!= null)&&this.provider.equals(rhs.provider))))&&((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))))&&((this.childrenCount == rhs.childrenCount)||((this.childrenCount!= null)&&this.childrenCount.equals(rhs.childrenCount))))&&((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.synonyms == rhs.synonyms)||((this.synonyms!= null)&&this.synonyms.equals(rhs.synonyms))))&&((this.dataProducts == rhs.dataProducts)||((this.dataProducts!= null)&&this.dataProducts.equals(rhs.dataProducts))))&&((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.reviewers == rhs.reviewers)||((this.reviewers!= null)&&this.reviewers.equals(rhs.reviewers))))&&((this.usageCount == rhs.usageCount)||((this.usageCount!= null)&&this.usageCount.equals(rhs.usageCount))))&&((this.tags == rhs.tags)||((this.tags!= null)&&this.tags.equals(rhs.tags))))&&((this.glossary == rhs.glossary)||((this.glossary!= null)&&this.glossary.equals(rhs.glossary))))&&((this.deleted == rhs.deleted)||((this.deleted!= null)&&this.deleted.equals(rhs.deleted))))&&((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.style == rhs.style)||((this.style!= null)&&this.style.equals(rhs.style))))&&((this.votes == rhs.votes)||((this.votes!= null)&&this.votes.equals(rhs.votes))))&&((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status))));
}
@Generated("jsonschema2pojo")
public enum Status {
DRAFT("Draft"),
IN_REVIEW("In Review"),
APPROVED("Approved"),
DEPRECATED("Deprecated"),
REJECTED("Rejected");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (GlossaryTerm.Status c: values()) {
CONSTANTS.put(c.value, c);
}
}
Status(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static GlossaryTerm.Status fromValue(String value) {
GlossaryTerm.Status constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
}