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.util.UUID;
import org.openmetadata.client.model.SubscriptionStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* SubscriptionDestination
*/
@JsonPropertyOrder({
SubscriptionDestination.JSON_PROPERTY_CATEGORY,
SubscriptionDestination.JSON_PROPERTY_CONFIG,
SubscriptionDestination.JSON_PROPERTY_ENABLED,
SubscriptionDestination.JSON_PROPERTY_ID,
SubscriptionDestination.JSON_PROPERTY_READ_TIMEOUT,
SubscriptionDestination.JSON_PROPERTY_STATUS_DETAILS,
SubscriptionDestination.JSON_PROPERTY_TIMEOUT,
SubscriptionDestination.JSON_PROPERTY_TYPE
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-13T20:15:57.513387948Z[Etc/UTC]")
public class SubscriptionDestination {
/**
* Gets or Sets category
*/
public enum CategoryEnum {
USERS("Users"),
TEAMS("Teams"),
ADMINS("Admins"),
ASSIGNEES("Assignees"),
OWNERS("Owners"),
MENTIONS("Mentions"),
FOLLOWERS("Followers"),
EXTERNAL("External");
private String value;
CategoryEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static CategoryEnum fromValue(String value) {
for (CategoryEnum b : CategoryEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_CATEGORY = "category";
private CategoryEnum category;
public static final String JSON_PROPERTY_CONFIG = "config";
private Object config;
public static final String JSON_PROPERTY_ENABLED = "enabled";
private Boolean enabled;
public static final String JSON_PROPERTY_ID = "id";
private UUID id;
public static final String JSON_PROPERTY_READ_TIMEOUT = "readTimeout";
private Integer readTimeout;
public static final String JSON_PROPERTY_STATUS_DETAILS = "statusDetails";
private SubscriptionStatus statusDetails;
public static final String JSON_PROPERTY_TIMEOUT = "timeout";
private Integer timeout;
/**
* Gets or Sets type
*/
public enum TypeEnum {
WEBHOOK("Webhook"),
SLACK("Slack"),
MSTEAMS("MsTeams"),
GCHAT("GChat"),
EMAIL("Email"),
ACTIVITYFEED("ActivityFeed");
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 SubscriptionDestination() {
}
public SubscriptionDestination category(CategoryEnum category) {
this.category = category;
return this;
}
/**
* Get category
* @return category
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_CATEGORY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public CategoryEnum getCategory() {
return category;
}
@JsonProperty(JSON_PROPERTY_CATEGORY)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setCategory(CategoryEnum category) {
this.category = category;
}
public SubscriptionDestination config(Object config) {
this.config = config;
return this;
}
/**
* Get config
* @return config
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CONFIG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Object getConfig() {
return config;
}
@JsonProperty(JSON_PROPERTY_CONFIG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setConfig(Object config) {
this.config = config;
}
public SubscriptionDestination enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Get enabled
* @return enabled
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ENABLED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getEnabled() {
return enabled;
}
@JsonProperty(JSON_PROPERTY_ENABLED)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
public SubscriptionDestination 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 SubscriptionDestination readTimeout(Integer readTimeout) {
this.readTimeout = readTimeout;
return this;
}
/**
* Get readTimeout
* @return readTimeout
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_READ_TIMEOUT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getReadTimeout() {
return readTimeout;
}
@JsonProperty(JSON_PROPERTY_READ_TIMEOUT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReadTimeout(Integer readTimeout) {
this.readTimeout = readTimeout;
}
public SubscriptionDestination statusDetails(SubscriptionStatus statusDetails) {
this.statusDetails = statusDetails;
return this;
}
/**
* Get statusDetails
* @return statusDetails
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_STATUS_DETAILS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public SubscriptionStatus getStatusDetails() {
return statusDetails;
}
@JsonProperty(JSON_PROPERTY_STATUS_DETAILS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStatusDetails(SubscriptionStatus statusDetails) {
this.statusDetails = statusDetails;
}
public SubscriptionDestination timeout(Integer timeout) {
this.timeout = timeout;
return this;
}
/**
* Get timeout
* @return timeout
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_TIMEOUT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getTimeout() {
return timeout;
}
@JsonProperty(JSON_PROPERTY_TIMEOUT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTimeout(Integer timeout) {
this.timeout = timeout;
}
public SubscriptionDestination type(TypeEnum type) {
this.type = type;
return this;
}
/**
* Get type
* @return type
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public TypeEnum getType() {
return type;
}
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setType(TypeEnum type) {
this.type = type;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
SubscriptionDestination subscriptionDestination = (SubscriptionDestination) o;
return Objects.equals(this.category, subscriptionDestination.category) &&
Objects.equals(this.config, subscriptionDestination.config) &&
Objects.equals(this.enabled, subscriptionDestination.enabled) &&
Objects.equals(this.id, subscriptionDestination.id) &&
Objects.equals(this.readTimeout, subscriptionDestination.readTimeout) &&
Objects.equals(this.statusDetails, subscriptionDestination.statusDetails) &&
Objects.equals(this.timeout, subscriptionDestination.timeout) &&
Objects.equals(this.type, subscriptionDestination.type);
}
@Override
public int hashCode() {
return Objects.hash(category, config, enabled, id, readTimeout, statusDetails, timeout, type);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SubscriptionDestination {\n");
sb.append(" category: ").append(toIndentedString(category)).append("\n");
sb.append(" config: ").append(toIndentedString(config)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" readTimeout: ").append(toIndentedString(readTimeout)).append("\n");
sb.append(" statusDetails: ").append(toIndentedString(statusDetails)).append("\n");
sb.append(" timeout: ").append(toIndentedString(timeout)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).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 ");
}
}
