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.1.3
* 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 io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.UUID;
import org.openmetadata.client.model.ChangeDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* ChangeEvent
*/
@JsonPropertyOrder({
ChangeEvent.JSON_PROPERTY_CHANGE_DESCRIPTION,
ChangeEvent.JSON_PROPERTY_CURRENT_VERSION,
ChangeEvent.JSON_PROPERTY_ENTITY,
ChangeEvent.JSON_PROPERTY_ENTITY_FULLY_QUALIFIED_NAME,
ChangeEvent.JSON_PROPERTY_ENTITY_ID,
ChangeEvent.JSON_PROPERTY_ENTITY_TYPE,
ChangeEvent.JSON_PROPERTY_EVENT_TYPE,
ChangeEvent.JSON_PROPERTY_PREVIOUS_VERSION,
ChangeEvent.JSON_PROPERTY_TIMESTAMP,
ChangeEvent.JSON_PROPERTY_USER_NAME
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-08-29T10:43:32.398952Z[Etc/UTC]")
public class ChangeEvent {
public static final String JSON_PROPERTY_CHANGE_DESCRIPTION = "changeDescription";
private ChangeDescription changeDescription;
public static final String JSON_PROPERTY_CURRENT_VERSION = "currentVersion";
private Double currentVersion;
public static final String JSON_PROPERTY_ENTITY = "entity";
private Object entity;
public static final String JSON_PROPERTY_ENTITY_FULLY_QUALIFIED_NAME = "entityFullyQualifiedName";
private String entityFullyQualifiedName;
public static final String JSON_PROPERTY_ENTITY_ID = "entityId";
private UUID entityId;
public static final String JSON_PROPERTY_ENTITY_TYPE = "entityType";
private String entityType;
/**
* Gets or Sets eventType
*/
public enum EventTypeEnum {
ENTITYCREATED("entityCreated"),
ENTITYUPDATED("entityUpdated"),
ENTITYNOCHANGE("entityNoChange"),
ENTITYSOFTDELETED("entitySoftDeleted"),
ENTITYRESTORED("entityRestored"),
ENTITYDELETED("entityDeleted");
private String value;
EventTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static EventTypeEnum fromValue(String value) {
for (EventTypeEnum b : EventTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_EVENT_TYPE = "eventType";
private EventTypeEnum eventType;
public static final String JSON_PROPERTY_PREVIOUS_VERSION = "previousVersion";
private Double previousVersion;
public static final String JSON_PROPERTY_TIMESTAMP = "timestamp";
private Long timestamp;
public static final String JSON_PROPERTY_USER_NAME = "userName";
private String userName;
public ChangeEvent() {
}
public ChangeEvent changeDescription(ChangeDescription changeDescription) {
this.changeDescription = changeDescription;
return this;
}
/**
* Get changeDescription
* @return changeDescription
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CHANGE_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ChangeDescription getChangeDescription() {
return changeDescription;
}
@JsonProperty(JSON_PROPERTY_CHANGE_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setChangeDescription(ChangeDescription changeDescription) {
this.changeDescription = changeDescription;
}
public ChangeEvent currentVersion(Double currentVersion) {
this.currentVersion = currentVersion;
return this;
}
/**
* Get currentVersion
* @return currentVersion
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_CURRENT_VERSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getCurrentVersion() {
return currentVersion;
}
@JsonProperty(JSON_PROPERTY_CURRENT_VERSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCurrentVersion(Double currentVersion) {
this.currentVersion = currentVersion;
}
public ChangeEvent entity(Object entity) {
this.entity = entity;
return this;
}
/**
* Get entity
* @return entity
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_ENTITY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Object getEntity() {
return entity;
}
@JsonProperty(JSON_PROPERTY_ENTITY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEntity(Object entity) {
this.entity = entity;
}
public ChangeEvent entityFullyQualifiedName(String entityFullyQualifiedName) {
this.entityFullyQualifiedName = entityFullyQualifiedName;
return this;
}
/**
* Get entityFullyQualifiedName
* @return entityFullyQualifiedName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_ENTITY_FULLY_QUALIFIED_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEntityFullyQualifiedName() {
return entityFullyQualifiedName;
}
@JsonProperty(JSON_PROPERTY_ENTITY_FULLY_QUALIFIED_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEntityFullyQualifiedName(String entityFullyQualifiedName) {
this.entityFullyQualifiedName = entityFullyQualifiedName;
}
public ChangeEvent entityId(UUID entityId) {
this.entityId = entityId;
return this;
}
/**
* Get entityId
* @return entityId
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public UUID getEntityId() {
return entityId;
}
@JsonProperty(JSON_PROPERTY_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setEntityId(UUID entityId) {
this.entityId = entityId;
}
public ChangeEvent entityType(String entityType) {
this.entityType = entityType;
return this;
}
/**
* Get entityType
* @return entityType
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getEntityType() {
return entityType;
}
@JsonProperty(JSON_PROPERTY_ENTITY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setEntityType(String entityType) {
this.entityType = entityType;
}
public ChangeEvent eventType(EventTypeEnum eventType) {
this.eventType = eventType;
return this;
}
/**
* Get eventType
* @return eventType
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_EVENT_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public EventTypeEnum getEventType() {
return eventType;
}
@JsonProperty(JSON_PROPERTY_EVENT_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setEventType(EventTypeEnum eventType) {
this.eventType = eventType;
}
public ChangeEvent previousVersion(Double previousVersion) {
this.previousVersion = previousVersion;
return this;
}
/**
* Get previousVersion
* @return previousVersion
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_PREVIOUS_VERSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getPreviousVersion() {
return previousVersion;
}
@JsonProperty(JSON_PROPERTY_PREVIOUS_VERSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPreviousVersion(Double previousVersion) {
this.previousVersion = previousVersion;
}
public ChangeEvent timestamp(Long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Get timestamp
* @return timestamp
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_TIMESTAMP)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Long getTimestamp() {
return timestamp;
}
@JsonProperty(JSON_PROPERTY_TIMESTAMP)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setTimestamp(Long timestamp) {
this.timestamp = timestamp;
}
public ChangeEvent userName(String userName) {
this.userName = userName;
return this;
}
/**
* Get userName
* @return userName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_USER_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getUserName() {
return userName;
}
@JsonProperty(JSON_PROPERTY_USER_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUserName(String userName) {
this.userName = userName;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ChangeEvent changeEvent = (ChangeEvent) o;
return Objects.equals(this.changeDescription, changeEvent.changeDescription) &&
Objects.equals(this.currentVersion, changeEvent.currentVersion) &&
Objects.equals(this.entity, changeEvent.entity) &&
Objects.equals(this.entityFullyQualifiedName, changeEvent.entityFullyQualifiedName) &&
Objects.equals(this.entityId, changeEvent.entityId) &&
Objects.equals(this.entityType, changeEvent.entityType) &&
Objects.equals(this.eventType, changeEvent.eventType) &&
Objects.equals(this.previousVersion, changeEvent.previousVersion) &&
Objects.equals(this.timestamp, changeEvent.timestamp) &&
Objects.equals(this.userName, changeEvent.userName);
}
@Override
public int hashCode() {
return Objects.hash(changeDescription, currentVersion, entity, entityFullyQualifiedName, entityId, entityType, eventType, previousVersion, timestamp, userName);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ChangeEvent {\n");
sb.append(" changeDescription: ").append(toIndentedString(changeDescription)).append("\n");
sb.append(" currentVersion: ").append(toIndentedString(currentVersion)).append("\n");
sb.append(" entity: ").append(toIndentedString(entity)).append("\n");
sb.append(" entityFullyQualifiedName: ").append(toIndentedString(entityFullyQualifiedName)).append("\n");
sb.append(" entityId: ").append(toIndentedString(entityId)).append("\n");
sb.append(" entityType: ").append(toIndentedString(entityType)).append("\n");
sb.append(" eventType: ").append(toIndentedString(eventType)).append("\n");
sb.append(" previousVersion: ").append(toIndentedString(previousVersion)).append("\n");
sb.append(" timestamp: ").append(toIndentedString(timestamp)).append("\n");
sb.append(" userName: ").append(toIndentedString(userName)).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 ");
}
}
