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.5.4
* 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 org.openmetadata.client.model.APISchema;
import org.openmetadata.client.model.EntityReference;
import org.openmetadata.client.model.LifeCycle;
import org.openmetadata.client.model.TagLabel;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* CreateAPIEndpoint
*/
@JsonPropertyOrder({
CreateAPIEndpoint.JSON_PROPERTY_API_COLLECTION,
CreateAPIEndpoint.JSON_PROPERTY_DATA_PRODUCTS,
CreateAPIEndpoint.JSON_PROPERTY_DESCRIPTION,
CreateAPIEndpoint.JSON_PROPERTY_DISPLAY_NAME,
CreateAPIEndpoint.JSON_PROPERTY_DOMAIN,
CreateAPIEndpoint.JSON_PROPERTY_ENDPOINT_U_R_L,
CreateAPIEndpoint.JSON_PROPERTY_EXTENSION,
CreateAPIEndpoint.JSON_PROPERTY_LIFE_CYCLE,
CreateAPIEndpoint.JSON_PROPERTY_NAME,
CreateAPIEndpoint.JSON_PROPERTY_OWNERS,
CreateAPIEndpoint.JSON_PROPERTY_REQUEST_METHOD,
CreateAPIEndpoint.JSON_PROPERTY_REQUEST_SCHEMA,
CreateAPIEndpoint.JSON_PROPERTY_RESPONSE_SCHEMA,
CreateAPIEndpoint.JSON_PROPERTY_REVIEWERS,
CreateAPIEndpoint.JSON_PROPERTY_SOURCE_HASH,
CreateAPIEndpoint.JSON_PROPERTY_SOURCE_URL,
CreateAPIEndpoint.JSON_PROPERTY_TAGS
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-13T20:15:57.513387948Z[Etc/UTC]")
public class CreateAPIEndpoint {
public static final String JSON_PROPERTY_API_COLLECTION = "apiCollection";
private String apiCollection;
public static final String JSON_PROPERTY_DATA_PRODUCTS = "dataProducts";
private List dataProducts;
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_DOMAIN = "domain";
private String domain;
public static final String JSON_PROPERTY_ENDPOINT_U_R_L = "endpointURL";
private URI endpointURL;
public static final String JSON_PROPERTY_EXTENSION = "extension";
private Object extension;
public static final String JSON_PROPERTY_LIFE_CYCLE = "lifeCycle";
private LifeCycle lifeCycle;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
public static final String JSON_PROPERTY_OWNERS = "owners";
private List owners;
/**
* Gets or Sets requestMethod
*/
public enum RequestMethodEnum {
GET("GET"),
POST("POST"),
PUT("PUT"),
PATCH("PATCH"),
DELETE("DELETE"),
HEAD("HEAD"),
CONNECT("CONNECT"),
OPTIONS("OPTIONS"),
TRACE("TRACE");
private String value;
RequestMethodEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static RequestMethodEnum fromValue(String value) {
for (RequestMethodEnum b : RequestMethodEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_REQUEST_METHOD = "requestMethod";
private RequestMethodEnum requestMethod;
public static final String JSON_PROPERTY_REQUEST_SCHEMA = "requestSchema";
private APISchema requestSchema;
public static final String JSON_PROPERTY_RESPONSE_SCHEMA = "responseSchema";
private APISchema responseSchema;
public static final String JSON_PROPERTY_REVIEWERS = "reviewers";
private List reviewers;
public static final String JSON_PROPERTY_SOURCE_HASH = "sourceHash";
private String sourceHash;
public static final String JSON_PROPERTY_SOURCE_URL = "sourceUrl";
private String sourceUrl;
public static final String JSON_PROPERTY_TAGS = "tags";
private List tags;
public CreateAPIEndpoint() {
}
public CreateAPIEndpoint apiCollection(String apiCollection) {
this.apiCollection = apiCollection;
return this;
}
/**
* Get apiCollection
* @return apiCollection
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_API_COLLECTION)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getApiCollection() {
return apiCollection;
}
@JsonProperty(JSON_PROPERTY_API_COLLECTION)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setApiCollection(String apiCollection) {
this.apiCollection = apiCollection;
}
public CreateAPIEndpoint dataProducts(List dataProducts) {
this.dataProducts = dataProducts;
return this;
}
public CreateAPIEndpoint addDataProductsItem(String dataProductsItem) {
if (this.dataProducts == null) {
this.dataProducts = new ArrayList<>();
}
this.dataProducts.add(dataProductsItem);
return this;
}
/**
* Get dataProducts
* @return dataProducts
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DATA_PRODUCTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getDataProducts() {
return dataProducts;
}
@JsonProperty(JSON_PROPERTY_DATA_PRODUCTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDataProducts(List dataProducts) {
this.dataProducts = dataProducts;
}
public CreateAPIEndpoint 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 CreateAPIEndpoint displayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Get displayName
* @return displayName
**/
@javax.annotation.Nullable
@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 CreateAPIEndpoint domain(String domain) {
this.domain = domain;
return this;
}
/**
* Get domain
* @return domain
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DOMAIN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDomain() {
return domain;
}
@JsonProperty(JSON_PROPERTY_DOMAIN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDomain(String domain) {
this.domain = domain;
}
public CreateAPIEndpoint endpointURL(URI endpointURL) {
this.endpointURL = endpointURL;
return this;
}
/**
* Get endpointURL
* @return endpointURL
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_ENDPOINT_U_R_L)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public URI getEndpointURL() {
return endpointURL;
}
@JsonProperty(JSON_PROPERTY_ENDPOINT_U_R_L)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setEndpointURL(URI endpointURL) {
this.endpointURL = endpointURL;
}
public CreateAPIEndpoint extension(Object extension) {
this.extension = extension;
return this;
}
/**
* Get extension
* @return extension
**/
@javax.annotation.Nullable
@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 CreateAPIEndpoint lifeCycle(LifeCycle lifeCycle) {
this.lifeCycle = lifeCycle;
return this;
}
/**
* Get lifeCycle
* @return lifeCycle
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_LIFE_CYCLE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public LifeCycle getLifeCycle() {
return lifeCycle;
}
@JsonProperty(JSON_PROPERTY_LIFE_CYCLE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLifeCycle(LifeCycle lifeCycle) {
this.lifeCycle = lifeCycle;
}
public CreateAPIEndpoint name(String name) {
this.name = name;
return this;
}
/**
* Get name
* @return name
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setName(String name) {
this.name = name;
}
public CreateAPIEndpoint owners(List owners) {
this.owners = owners;
return this;
}
public CreateAPIEndpoint addOwnersItem(EntityReference ownersItem) {
if (this.owners == null) {
this.owners = new ArrayList<>();
}
this.owners.add(ownersItem);
return this;
}
/**
* Get owners
* @return owners
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_OWNERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getOwners() {
return owners;
}
@JsonProperty(JSON_PROPERTY_OWNERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setOwners(List owners) {
this.owners = owners;
}
public CreateAPIEndpoint requestMethod(RequestMethodEnum requestMethod) {
this.requestMethod = requestMethod;
return this;
}
/**
* Get requestMethod
* @return requestMethod
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_REQUEST_METHOD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public RequestMethodEnum getRequestMethod() {
return requestMethod;
}
@JsonProperty(JSON_PROPERTY_REQUEST_METHOD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setRequestMethod(RequestMethodEnum requestMethod) {
this.requestMethod = requestMethod;
}
public CreateAPIEndpoint requestSchema(APISchema requestSchema) {
this.requestSchema = requestSchema;
return this;
}
/**
* Get requestSchema
* @return requestSchema
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_REQUEST_SCHEMA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public APISchema getRequestSchema() {
return requestSchema;
}
@JsonProperty(JSON_PROPERTY_REQUEST_SCHEMA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setRequestSchema(APISchema requestSchema) {
this.requestSchema = requestSchema;
}
public CreateAPIEndpoint responseSchema(APISchema responseSchema) {
this.responseSchema = responseSchema;
return this;
}
/**
* Get responseSchema
* @return responseSchema
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_RESPONSE_SCHEMA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public APISchema getResponseSchema() {
return responseSchema;
}
@JsonProperty(JSON_PROPERTY_RESPONSE_SCHEMA)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setResponseSchema(APISchema responseSchema) {
this.responseSchema = responseSchema;
}
public CreateAPIEndpoint reviewers(List reviewers) {
this.reviewers = reviewers;
return this;
}
public CreateAPIEndpoint addReviewersItem(EntityReference reviewersItem) {
if (this.reviewers == null) {
this.reviewers = new ArrayList<>();
}
this.reviewers.add(reviewersItem);
return this;
}
/**
* Get reviewers
* @return reviewers
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_REVIEWERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getReviewers() {
return reviewers;
}
@JsonProperty(JSON_PROPERTY_REVIEWERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReviewers(List reviewers) {
this.reviewers = reviewers;
}
public CreateAPIEndpoint sourceHash(String sourceHash) {
this.sourceHash = sourceHash;
return this;
}
/**
* Get sourceHash
* @return sourceHash
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_SOURCE_HASH)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSourceHash() {
return sourceHash;
}
@JsonProperty(JSON_PROPERTY_SOURCE_HASH)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSourceHash(String sourceHash) {
this.sourceHash = sourceHash;
}
public CreateAPIEndpoint sourceUrl(String sourceUrl) {
this.sourceUrl = sourceUrl;
return this;
}
/**
* Get sourceUrl
* @return sourceUrl
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_SOURCE_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getSourceUrl() {
return sourceUrl;
}
@JsonProperty(JSON_PROPERTY_SOURCE_URL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSourceUrl(String sourceUrl) {
this.sourceUrl = sourceUrl;
}
public CreateAPIEndpoint tags(List tags) {
this.tags = tags;
return this;
}
public CreateAPIEndpoint addTagsItem(TagLabel tagsItem) {
if (this.tags == null) {
this.tags = new ArrayList<>();
}
this.tags.add(tagsItem);
return this;
}
/**
* Get tags
* @return tags
**/
@javax.annotation.Nullable
@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;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreateAPIEndpoint createAPIEndpoint = (CreateAPIEndpoint) o;
return Objects.equals(this.apiCollection, createAPIEndpoint.apiCollection) &&
Objects.equals(this.dataProducts, createAPIEndpoint.dataProducts) &&
Objects.equals(this.description, createAPIEndpoint.description) &&
Objects.equals(this.displayName, createAPIEndpoint.displayName) &&
Objects.equals(this.domain, createAPIEndpoint.domain) &&
Objects.equals(this.endpointURL, createAPIEndpoint.endpointURL) &&
Objects.equals(this.extension, createAPIEndpoint.extension) &&
Objects.equals(this.lifeCycle, createAPIEndpoint.lifeCycle) &&
Objects.equals(this.name, createAPIEndpoint.name) &&
Objects.equals(this.owners, createAPIEndpoint.owners) &&
Objects.equals(this.requestMethod, createAPIEndpoint.requestMethod) &&
Objects.equals(this.requestSchema, createAPIEndpoint.requestSchema) &&
Objects.equals(this.responseSchema, createAPIEndpoint.responseSchema) &&
Objects.equals(this.reviewers, createAPIEndpoint.reviewers) &&
Objects.equals(this.sourceHash, createAPIEndpoint.sourceHash) &&
Objects.equals(this.sourceUrl, createAPIEndpoint.sourceUrl) &&
Objects.equals(this.tags, createAPIEndpoint.tags);
}
@Override
public int hashCode() {
return Objects.hash(apiCollection, dataProducts, description, displayName, domain, endpointURL, extension, lifeCycle, name, owners, requestMethod, requestSchema, responseSchema, reviewers, sourceHash, sourceUrl, tags);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateAPIEndpoint {\n");
sb.append(" apiCollection: ").append(toIndentedString(apiCollection)).append("\n");
sb.append(" dataProducts: ").append(toIndentedString(dataProducts)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" domain: ").append(toIndentedString(domain)).append("\n");
sb.append(" endpointURL: ").append(toIndentedString(endpointURL)).append("\n");
sb.append(" extension: ").append(toIndentedString(extension)).append("\n");
sb.append(" lifeCycle: ").append(toIndentedString(lifeCycle)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" owners: ").append(toIndentedString(owners)).append("\n");
sb.append(" requestMethod: ").append(toIndentedString(requestMethod)).append("\n");
sb.append(" requestSchema: ").append(toIndentedString(requestSchema)).append("\n");
sb.append(" responseSchema: ").append(toIndentedString(responseSchema)).append("\n");
sb.append(" reviewers: ").append(toIndentedString(reviewers)).append("\n");
sb.append(" sourceHash: ").append(toIndentedString(sourceHash)).append("\n");
sb.append(" sourceUrl: ").append(toIndentedString(sourceUrl)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).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 ");
}
}
