org.openmetadata.schema.api.data.CreateSearchIndex Maven / Gradle / Ivy
package org.openmetadata.schema.api.data;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.CreateEntity;
import org.openmetadata.schema.type.EntityReference;
import org.openmetadata.schema.type.LifeCycle;
import org.openmetadata.schema.type.SearchIndexField;
import org.openmetadata.schema.type.TagLabel;
import org.openmetadata.schema.type.searchindex.SearchIndexSettings;
/**
* CreateSearchIndexRequest
*
* Create a SearchIndex entity request
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"name",
"displayName",
"description",
"service",
"fields",
"searchIndexSettings",
"indexType",
"owners",
"tags",
"extension",
"domain",
"dataProducts",
"lifeCycle",
"sourceHash"
})
@Generated("jsonschema2pojo")
public class CreateSearchIndex implements CreateEntity
{
/**
* 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 SearchIndex.
*
*/
@JsonProperty("displayName")
@JsonPropertyDescription("Display Name that identifies this SearchIndex.")
private String displayName;
/**
* Text in Markdown format.@om-field-type
*
*/
@JsonProperty("description")
@JsonPropertyDescription("Text in Markdown format.")
private String description;
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
* (Required)
*
*/
@JsonProperty("service")
@JsonPropertyDescription("A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.")
@Size(min = 1, max = 3072)
@NotNull
private String service;
/**
* Fields in this SearchIndex.
* (Required)
*
*/
@JsonProperty("fields")
@JsonPropertyDescription("Fields in this SearchIndex.")
@Valid
@NotNull
private List fields = null;
/**
* Contains key/value pair of SearchIndex Settings.
*
*/
@JsonProperty("searchIndexSettings")
@JsonPropertyDescription("Contains key/value pair of SearchIndex Settings.")
@Valid
private SearchIndexSettings searchIndexSettings;
/**
* Whether the entity is index or index template.
*
*/
@JsonProperty("indexType")
@JsonPropertyDescription("Whether the entity is index or index template.")
private CreateSearchIndex.IndexType indexType = CreateSearchIndex.IndexType.fromValue("Index");
/**
* 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;
/**
* Tags for this SearchIndex
*
*/
@JsonProperty("tags")
@JsonPropertyDescription("Tags for this SearchIndex")
@Valid
private List tags = null;
/**
* 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;
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
*
*/
@JsonProperty("domain")
@JsonPropertyDescription("A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.")
@Size(min = 1, max = 3072)
private String domain;
/**
* List of fully qualified names of data products this entity is part of.
*
*/
@JsonProperty("dataProducts")
@JsonPropertyDescription("List of fully qualified names of data products this entity is part of.")
@Valid
private List dataProducts = new ArrayList();
/**
* Life Cycle
*
* This schema defines Life Cycle Properties.
*
*/
@JsonProperty("lifeCycle")
@JsonPropertyDescription("This schema defines Life Cycle Properties.")
@Valid
private LifeCycle lifeCycle;
/**
* Source hash of the entity
*
*/
@JsonProperty("sourceHash")
@JsonPropertyDescription("Source hash of the entity")
@Size(min = 1, max = 32)
private String sourceHash;
/**
* 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 CreateSearchIndex withName(String name) {
this.name = name;
return this;
}
/**
* Display Name that identifies this SearchIndex.
*
*/
@JsonProperty("displayName")
public String getDisplayName() {
return displayName;
}
/**
* Display Name that identifies this SearchIndex.
*
*/
@JsonProperty("displayName")
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
public CreateSearchIndex withDisplayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Text in Markdown format.@om-field-type
*
*/
@JsonProperty("description")
public String getDescription() {
return description;
}
/**
* Text in Markdown format.@om-field-type
*
*/
@JsonProperty("description")
public void setDescription(String description) {
this.description = description;
}
public CreateSearchIndex withDescription(String description) {
this.description = description;
return this;
}
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
* (Required)
*
*/
@JsonProperty("service")
public String getService() {
return service;
}
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
* (Required)
*
*/
@JsonProperty("service")
public void setService(String service) {
this.service = service;
}
public CreateSearchIndex withService(String service) {
this.service = service;
return this;
}
/**
* Fields in this SearchIndex.
* (Required)
*
*/
@JsonProperty("fields")
public List getFields() {
return fields;
}
/**
* Fields in this SearchIndex.
* (Required)
*
*/
@JsonProperty("fields")
public void setFields(List fields) {
this.fields = fields;
}
public CreateSearchIndex withFields(List fields) {
this.fields = fields;
return this;
}
/**
* Contains key/value pair of SearchIndex Settings.
*
*/
@JsonProperty("searchIndexSettings")
public SearchIndexSettings getSearchIndexSettings() {
return searchIndexSettings;
}
/**
* Contains key/value pair of SearchIndex Settings.
*
*/
@JsonProperty("searchIndexSettings")
public void setSearchIndexSettings(SearchIndexSettings searchIndexSettings) {
this.searchIndexSettings = searchIndexSettings;
}
public CreateSearchIndex withSearchIndexSettings(SearchIndexSettings searchIndexSettings) {
this.searchIndexSettings = searchIndexSettings;
return this;
}
/**
* Whether the entity is index or index template.
*
*/
@JsonProperty("indexType")
public CreateSearchIndex.IndexType getIndexType() {
return indexType;
}
/**
* Whether the entity is index or index template.
*
*/
@JsonProperty("indexType")
public void setIndexType(CreateSearchIndex.IndexType indexType) {
this.indexType = indexType;
}
public CreateSearchIndex withIndexType(CreateSearchIndex.IndexType indexType) {
this.indexType = indexType;
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 CreateSearchIndex withOwners(List owners) {
this.owners = owners;
return this;
}
/**
* Tags for this SearchIndex
*
*/
@JsonProperty("tags")
public List getTags() {
return tags;
}
/**
* Tags for this SearchIndex
*
*/
@JsonProperty("tags")
public void setTags(List tags) {
this.tags = tags;
}
public CreateSearchIndex withTags(List tags) {
this.tags = tags;
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 CreateSearchIndex withExtension(Object extension) {
this.extension = extension;
return this;
}
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
*
*/
@JsonProperty("domain")
public String getDomain() {
return domain;
}
/**
* A unique name that identifies an entity. Example for table 'DatabaseService.Database.Schema.Table'.
*
*/
@JsonProperty("domain")
public void setDomain(String domain) {
this.domain = domain;
}
public CreateSearchIndex withDomain(String domain) {
this.domain = domain;
return this;
}
/**
* List of fully qualified names of data products this entity is part of.
*
*/
@JsonProperty("dataProducts")
public List getDataProducts() {
return dataProducts;
}
/**
* List of fully qualified names of data products this entity is part of.
*
*/
@JsonProperty("dataProducts")
public void setDataProducts(List dataProducts) {
this.dataProducts = dataProducts;
}
public CreateSearchIndex withDataProducts(List dataProducts) {
this.dataProducts = dataProducts;
return this;
}
/**
* Life Cycle
*
* This schema defines Life Cycle Properties.
*
*/
@JsonProperty("lifeCycle")
public LifeCycle getLifeCycle() {
return lifeCycle;
}
/**
* Life Cycle
*
* This schema defines Life Cycle Properties.
*
*/
@JsonProperty("lifeCycle")
public void setLifeCycle(LifeCycle lifeCycle) {
this.lifeCycle = lifeCycle;
}
public CreateSearchIndex withLifeCycle(LifeCycle lifeCycle) {
this.lifeCycle = lifeCycle;
return this;
}
/**
* Source hash of the entity
*
*/
@JsonProperty("sourceHash")
public String getSourceHash() {
return sourceHash;
}
/**
* Source hash of the entity
*
*/
@JsonProperty("sourceHash")
public void setSourceHash(String sourceHash) {
this.sourceHash = sourceHash;
}
public CreateSearchIndex withSourceHash(String sourceHash) {
this.sourceHash = sourceHash;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(CreateSearchIndex.class.getName()).append('@').append(Integer.toHexString(System.identityHashCode(this))).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("service");
sb.append('=');
sb.append(((this.service == null)?"":this.service));
sb.append(',');
sb.append("fields");
sb.append('=');
sb.append(((this.fields == null)?"":this.fields));
sb.append(',');
sb.append("searchIndexSettings");
sb.append('=');
sb.append(((this.searchIndexSettings == null)?"":this.searchIndexSettings));
sb.append(',');
sb.append("indexType");
sb.append('=');
sb.append(((this.indexType == null)?"":this.indexType));
sb.append(',');
sb.append("owners");
sb.append('=');
sb.append(((this.owners == null)?"":this.owners));
sb.append(',');
sb.append("tags");
sb.append('=');
sb.append(((this.tags == null)?"":this.tags));
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("lifeCycle");
sb.append('=');
sb.append(((this.lifeCycle == null)?"":this.lifeCycle));
sb.append(',');
sb.append("sourceHash");
sb.append('=');
sb.append(((this.sourceHash == null)?"":this.sourceHash));
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.extension == null)? 0 :this.extension.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.dataProducts == null)? 0 :this.dataProducts.hashCode()));
result = ((result* 31)+((this.owners == null)? 0 :this.owners.hashCode()));
result = ((result* 31)+((this.tags == null)? 0 :this.tags.hashCode()));
result = ((result* 31)+((this.indexType == null)? 0 :this.indexType.hashCode()));
result = ((result* 31)+((this.sourceHash == null)? 0 :this.sourceHash.hashCode()));
result = ((result* 31)+((this.service == null)? 0 :this.service.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.fields == null)? 0 :this.fields.hashCode()));
result = ((result* 31)+((this.searchIndexSettings == null)? 0 :this.searchIndexSettings.hashCode()));
result = ((result* 31)+((this.lifeCycle == null)? 0 :this.lifeCycle.hashCode()));
return result;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if ((other instanceof CreateSearchIndex) == false) {
return false;
}
CreateSearchIndex rhs = ((CreateSearchIndex) other);
return (((((((((((((((this.extension == rhs.extension)||((this.extension!= null)&&this.extension.equals(rhs.extension)))&&((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.dataProducts == rhs.dataProducts)||((this.dataProducts!= null)&&this.dataProducts.equals(rhs.dataProducts))))&&((this.owners == rhs.owners)||((this.owners!= null)&&this.owners.equals(rhs.owners))))&&((this.tags == rhs.tags)||((this.tags!= null)&&this.tags.equals(rhs.tags))))&&((this.indexType == rhs.indexType)||((this.indexType!= null)&&this.indexType.equals(rhs.indexType))))&&((this.sourceHash == rhs.sourceHash)||((this.sourceHash!= null)&&this.sourceHash.equals(rhs.sourceHash))))&&((this.service == rhs.service)||((this.service!= null)&&this.service.equals(rhs.service))))&&((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.fields == rhs.fields)||((this.fields!= null)&&this.fields.equals(rhs.fields))))&&((this.searchIndexSettings == rhs.searchIndexSettings)||((this.searchIndexSettings!= null)&&this.searchIndexSettings.equals(rhs.searchIndexSettings))))&&((this.lifeCycle == rhs.lifeCycle)||((this.lifeCycle!= null)&&this.lifeCycle.equals(rhs.lifeCycle))));
}
/**
* Whether the entity is index or index template.
*
*/
@Generated("jsonschema2pojo")
public enum IndexType {
INDEX("Index"),
INDEX_TEMPLATE("IndexTemplate");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (CreateSearchIndex.IndexType c: values()) {
CONSTANTS.put(c.value, c);
}
}
IndexType(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static CreateSearchIndex.IndexType fromValue(String value) {
CreateSearchIndex.IndexType constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
}