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.0.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.ArrayList;
import java.util.List;
import org.openmetadata.client.model.EntityReference;
import org.openmetadata.client.model.TagLabel;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* CreateQuery
*/
@JsonPropertyOrder({
CreateQuery.JSON_PROPERTY_DESCRIPTION,
CreateQuery.JSON_PROPERTY_DISPLAY_NAME,
CreateQuery.JSON_PROPERTY_DURATION,
CreateQuery.JSON_PROPERTY_EXTENSION,
CreateQuery.JSON_PROPERTY_NAME,
CreateQuery.JSON_PROPERTY_OWNER,
CreateQuery.JSON_PROPERTY_QUERY,
CreateQuery.JSON_PROPERTY_QUERY_DATE,
CreateQuery.JSON_PROPERTY_QUERY_USED_IN,
CreateQuery.JSON_PROPERTY_TAGS,
CreateQuery.JSON_PROPERTY_USERS
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-06-06T17:05:44.995298Z[Etc/UTC]")
public class CreateQuery {
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_DISPLAY_NAME = "displayName";
private String displayName;
public static final String JSON_PROPERTY_DURATION = "duration";
private Double duration;
public static final String JSON_PROPERTY_EXTENSION = "extension";
private Object extension;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
public static final String JSON_PROPERTY_OWNER = "owner";
private EntityReference owner;
public static final String JSON_PROPERTY_QUERY = "query";
private String query;
public static final String JSON_PROPERTY_QUERY_DATE = "queryDate";
private Long queryDate;
public static final String JSON_PROPERTY_QUERY_USED_IN = "queryUsedIn";
private List queryUsedIn = null;
public static final String JSON_PROPERTY_TAGS = "tags";
private List tags = null;
public static final String JSON_PROPERTY_USERS = "users";
private List users = null;
public CreateQuery() {
}
public CreateQuery description(String description) {
this.description = description;
return this;
}
/**
* Get description
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@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 CreateQuery displayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Get displayName
* @return displayName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_DISPLAY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDisplayName() {
return displayName;
}
@JsonProperty(JSON_PROPERTY_DISPLAY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
public CreateQuery duration(Double duration) {
this.duration = duration;
return this;
}
/**
* Get duration
* @return duration
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_DURATION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getDuration() {
return duration;
}
@JsonProperty(JSON_PROPERTY_DURATION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDuration(Double duration) {
this.duration = duration;
}
public CreateQuery extension(Object extension) {
this.extension = extension;
return this;
}
/**
* Get extension
* @return extension
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_EXTENSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Object getExtension() {
return extension;
}
@JsonProperty(JSON_PROPERTY_EXTENSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setExtension(Object extension) {
this.extension = extension;
}
public CreateQuery name(String name) {
this.name = name;
return this;
}
/**
* Get name
* @return name
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setName(String name) {
this.name = name;
}
public CreateQuery owner(EntityReference owner) {
this.owner = owner;
return this;
}
/**
* Get owner
* @return owner
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_OWNER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public EntityReference getOwner() {
return owner;
}
@JsonProperty(JSON_PROPERTY_OWNER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setOwner(EntityReference owner) {
this.owner = owner;
}
public CreateQuery query(String query) {
this.query = query;
return this;
}
/**
* Get query
* @return query
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_QUERY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getQuery() {
return query;
}
@JsonProperty(JSON_PROPERTY_QUERY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setQuery(String query) {
this.query = query;
}
public CreateQuery queryDate(Long queryDate) {
this.queryDate = queryDate;
return this;
}
/**
* Get queryDate
* @return queryDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_QUERY_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getQueryDate() {
return queryDate;
}
@JsonProperty(JSON_PROPERTY_QUERY_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setQueryDate(Long queryDate) {
this.queryDate = queryDate;
}
public CreateQuery queryUsedIn(List queryUsedIn) {
this.queryUsedIn = queryUsedIn;
return this;
}
public CreateQuery addQueryUsedInItem(EntityReference queryUsedInItem) {
if (this.queryUsedIn == null) {
this.queryUsedIn = new ArrayList<>();
}
this.queryUsedIn.add(queryUsedInItem);
return this;
}
/**
* Get queryUsedIn
* @return queryUsedIn
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_QUERY_USED_IN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getQueryUsedIn() {
return queryUsedIn;
}
@JsonProperty(JSON_PROPERTY_QUERY_USED_IN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setQueryUsedIn(List queryUsedIn) {
this.queryUsedIn = queryUsedIn;
}
public CreateQuery tags(List tags) {
this.tags = tags;
return this;
}
public CreateQuery addTagsItem(TagLabel tagsItem) {
if (this.tags == null) {
this.tags = new ArrayList<>();
}
this.tags.add(tagsItem);
return this;
}
/**
* Get tags
* @return tags
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_TAGS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getTags() {
return tags;
}
@JsonProperty(JSON_PROPERTY_TAGS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTags(List tags) {
this.tags = tags;
}
public CreateQuery users(List users) {
this.users = users;
return this;
}
public CreateQuery addUsersItem(String usersItem) {
if (this.users == null) {
this.users = new ArrayList<>();
}
this.users.add(usersItem);
return this;
}
/**
* Get users
* @return users
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_USERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getUsers() {
return users;
}
@JsonProperty(JSON_PROPERTY_USERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUsers(List users) {
this.users = users;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreateQuery createQuery = (CreateQuery) o;
return Objects.equals(this.description, createQuery.description) &&
Objects.equals(this.displayName, createQuery.displayName) &&
Objects.equals(this.duration, createQuery.duration) &&
Objects.equals(this.extension, createQuery.extension) &&
Objects.equals(this.name, createQuery.name) &&
Objects.equals(this.owner, createQuery.owner) &&
Objects.equals(this.query, createQuery.query) &&
Objects.equals(this.queryDate, createQuery.queryDate) &&
Objects.equals(this.queryUsedIn, createQuery.queryUsedIn) &&
Objects.equals(this.tags, createQuery.tags) &&
Objects.equals(this.users, createQuery.users);
}
@Override
public int hashCode() {
return Objects.hash(description, displayName, duration, extension, name, owner, query, queryDate, queryUsedIn, tags, users);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateQuery {\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" duration: ").append(toIndentedString(duration)).append("\n");
sb.append(" extension: ").append(toIndentedString(extension)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" owner: ").append(toIndentedString(owner)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" queryDate: ").append(toIndentedString(queryDate)).append("\n");
sb.append(" queryUsedIn: ").append(toIndentedString(queryUsedIn)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" users: ").append(toIndentedString(users)).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 ");
}
}
