Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* OpenMetadata Apis
* --- title: APIs slug: /main-concepts/metadata-standard/apis --- # APIs OpenMetadata supports REST APIs for getting data and in and out of the metadata service. APIs are built using general best practices of REST API design. We take a schema-first approach by defining Types and Entities in JSON Schema. We implement APIs based on these schemas. ## Overview ### URI Following REST API conventions are followed for Resource URIs: - Operations for an entity are available through the Resource URI as a collection `.../api//entities`. - Plural of the entity name is used as the collection name - example `.../api/v1/users`. - Trailing forward slash is not used in the endpoint URI. Example use `.../api/v1/databases` instead of `.../api/v1/databases/`. - Resource URI for an entity instance by the entity id is `.../api/v1/entities/{id}`. - Resource URI for an entity instance by name is `.../api/v1/entities/name/{name}`. ### Resource Representation - The REST API calls return a response with JSON `Content-Type` and `Content-Length` that includes the length of the response. - All responses include the Resource ID field even though the id was provided in the request to simplify the consumption of the response at the client. - Entity names and field names use `camelCase` per Javascript naming convention. - All resources include an attribute `href` with Resource URI. All relationship fields of an entity will also include `href` links to the related resource for easy access. - Unknown fields sent by the client in API requests are not ignored to ensure the data sent by the client is not dropped at the server without the user being aware of it. ## API Organization You can find the swagger documentation [here](/swagger.html). In a nutshell: **Data Asset APIs** - support operations related to data asset entities. - `.../api/v1/databases` - `...api/v1/tables` - `.../api/v1/metrics` - `.../api/v1/dashboards` - `.../api/v1/reports` - `.../api/v1/pipelines` - `.../api/v1/topics` **Service APIs** - support operations related to services from which metadata is collected: - `.../api/v1/services` is the collection of all service resources. - `.../api/v1/services/databaseService` - APIs related to database services. This includes Transactional databases - MySQL, Postgres, MSSQL, Oracle, and Data Warehouses - Apache Hive BigQuery, Redshift, and Snowflake. - `.../api/v1/services/dashboardService` - APIs related to Dashboard Services. This includes Looker, Superset, and Tableau. - `.../api/v1/services/messagingService` - APIs related to Messaging Services. This includes Apache Kafka, Redpanda, - Kinesis, and others. **Teams & Users APIs** - `.../api/v1/teams` - APIs related to team entities - `.../api/v1/users` - APIs related to user entities **Search & Suggest APIs** - support search and suggest APIs: - `.../api/v1/search` - collection for search and suggest APIs - `.../api/v1/search/query` - search entities using query text - `.../api/v1/search/suggest` - get suggested entities used for auto-completion **Other APIs** - `.../api/v1/tags` for APIs related to Classification and Tag entities - `../api/v1/feeds` for APIs related to Threads and Posts entities - `.../api/v1/usage` for reporting usage information of entities
*
* The version of the OpenAPI document: 1.4.6-rc1
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.openmetadata.client.model;
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;
import org.openmetadata.client.model.EntityReference;
import org.openmetadata.client.model.TagLabel;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* Suggestion
*/
@JsonPropertyOrder({
Suggestion.JSON_PROPERTY_CREATED_AT,
Suggestion.JSON_PROPERTY_CREATED_BY,
Suggestion.JSON_PROPERTY_DESCRIPTION,
Suggestion.JSON_PROPERTY_ENTITY_LINK,
Suggestion.JSON_PROPERTY_HREF,
Suggestion.JSON_PROPERTY_ID,
Suggestion.JSON_PROPERTY_STATUS,
Suggestion.JSON_PROPERTY_TAG_LABELS,
Suggestion.JSON_PROPERTY_TYPE,
Suggestion.JSON_PROPERTY_UPDATED_AT,
Suggestion.JSON_PROPERTY_UPDATED_BY
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-25T09:42:14.348793228Z[Etc/UTC]")
public class Suggestion {
public static final String JSON_PROPERTY_CREATED_AT = "createdAt";
private Long createdAt;
public static final String JSON_PROPERTY_CREATED_BY = "createdBy";
private EntityReference createdBy;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_ENTITY_LINK = "entityLink";
private String entityLink;
public static final String JSON_PROPERTY_HREF = "href";
private URI href;
public static final String JSON_PROPERTY_ID = "id";
private UUID id;
/**
* Gets or Sets status
*/
public enum StatusEnum {
OPEN("Open"),
ACCEPTED("Accepted"),
REJECTED("Rejected");
private String value;
StatusEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static StatusEnum fromValue(String value) {
for (StatusEnum b : StatusEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_STATUS = "status";
private StatusEnum status;
public static final String JSON_PROPERTY_TAG_LABELS = "tagLabels";
private List tagLabels;
/**
* Gets or Sets type
*/
public enum TypeEnum {
SUGGESTDESCRIPTION("SuggestDescription"),
SUGGESTTAGLABEL("SuggestTagLabel");
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_TYPE = "type";
private TypeEnum type;
public static final String JSON_PROPERTY_UPDATED_AT = "updatedAt";
private Long updatedAt;
public static final String JSON_PROPERTY_UPDATED_BY = "updatedBy";
private String updatedBy;
public Suggestion() {
}
public Suggestion createdAt(Long createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* Get createdAt
* @return createdAt
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getCreatedAt() {
return createdAt;
}
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCreatedAt(Long createdAt) {
this.createdAt = createdAt;
}
public Suggestion createdBy(EntityReference createdBy) {
this.createdBy = createdBy;
return this;
}
/**
* Get createdBy
* @return createdBy
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CREATED_BY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public EntityReference getCreatedBy() {
return createdBy;
}
@JsonProperty(JSON_PROPERTY_CREATED_BY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCreatedBy(EntityReference createdBy) {
this.createdBy = createdBy;
}
public Suggestion description(String description) {
this.description = description;
return this;
}
/**
* Get description
* @return description
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDescription(String description) {
this.description = description;
}
public Suggestion entityLink(String entityLink) {
this.entityLink = entityLink;
return this;
}
/**
* Get entityLink
* @return entityLink
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ENTITY_LINK)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEntityLink() {
return entityLink;
}
@JsonProperty(JSON_PROPERTY_ENTITY_LINK)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEntityLink(String entityLink) {
this.entityLink = entityLink;
}
public Suggestion href(URI href) {
this.href = href;
return this;
}
/**
* Get href
* @return href
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_HREF)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public URI getHref() {
return href;
}
@JsonProperty(JSON_PROPERTY_HREF)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setHref(URI href) {
this.href = href;
}
public Suggestion id(UUID id) {
this.id = id;
return this;
}
/**
* Get id
* @return id
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public UUID getId() {
return id;
}
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setId(UUID id) {
this.id = id;
}
public Suggestion status(StatusEnum status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public StatusEnum getStatus() {
return status;
}
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStatus(StatusEnum status) {
this.status = status;
}
public Suggestion tagLabels(List tagLabels) {
this.tagLabels = tagLabels;
return this;
}
public Suggestion addTagLabelsItem(TagLabel tagLabelsItem) {
if (this.tagLabels == null) {
this.tagLabels = new ArrayList<>();
}
this.tagLabels.add(tagLabelsItem);
return this;
}
/**
* Get tagLabels
* @return tagLabels
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_TAG_LABELS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getTagLabels() {
return tagLabels;
}
@JsonProperty(JSON_PROPERTY_TAG_LABELS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTagLabels(List tagLabels) {
this.tagLabels = tagLabels;
}
public Suggestion type(TypeEnum type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public TypeEnum getType() {
return type;
}
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setType(TypeEnum type) {
this.type = type;
}
public Suggestion updatedAt(Long updatedAt) {
this.updatedAt = updatedAt;
return this;
}
/**
* Get updatedAt
* @return updatedAt
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_UPDATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getUpdatedAt() {
return updatedAt;
}
@JsonProperty(JSON_PROPERTY_UPDATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUpdatedAt(Long updatedAt) {
this.updatedAt = updatedAt;
}
public Suggestion updatedBy(String updatedBy) {
this.updatedBy = updatedBy;
return this;
}
/**
* Get updatedBy
* @return updatedBy
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_UPDATED_BY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getUpdatedBy() {
return updatedBy;
}
@JsonProperty(JSON_PROPERTY_UPDATED_BY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUpdatedBy(String updatedBy) {
this.updatedBy = updatedBy;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Suggestion suggestion = (Suggestion) o;
return Objects.equals(this.createdAt, suggestion.createdAt) &&
Objects.equals(this.createdBy, suggestion.createdBy) &&
Objects.equals(this.description, suggestion.description) &&
Objects.equals(this.entityLink, suggestion.entityLink) &&
Objects.equals(this.href, suggestion.href) &&
Objects.equals(this.id, suggestion.id) &&
Objects.equals(this.status, suggestion.status) &&
Objects.equals(this.tagLabels, suggestion.tagLabels) &&
Objects.equals(this.type, suggestion.type) &&
Objects.equals(this.updatedAt, suggestion.updatedAt) &&
Objects.equals(this.updatedBy, suggestion.updatedBy);
}
@Override
public int hashCode() {
return Objects.hash(createdAt, createdBy, description, entityLink, href, id, status, tagLabels, type, updatedAt, updatedBy);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Suggestion {\n");
sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n");
sb.append(" createdBy: ").append(toIndentedString(createdBy)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" entityLink: ").append(toIndentedString(entityLink)).append("\n");
sb.append(" href: ").append(toIndentedString(href)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" tagLabels: ").append(toIndentedString(tagLabels)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n");
sb.append(" updatedBy: ").append(toIndentedString(updatedBy)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
