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.
org.openmetadata.client.model.CreateEventSubscription Maven / Gradle / Ivy
/*
* 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 org.openmetadata.client.model.EntityReference;
import org.openmetadata.client.model.FilteringRules;
import org.openmetadata.client.model.TriggerConfig;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* CreateEventSubscription
*/
@JsonPropertyOrder({
CreateEventSubscription.JSON_PROPERTY_ALERT_TYPE,
CreateEventSubscription.JSON_PROPERTY_BATCH_SIZE,
CreateEventSubscription.JSON_PROPERTY_DESCRIPTION,
CreateEventSubscription.JSON_PROPERTY_DISPLAY_NAME,
CreateEventSubscription.JSON_PROPERTY_ENABLED,
CreateEventSubscription.JSON_PROPERTY_EXTENSION,
CreateEventSubscription.JSON_PROPERTY_FILTERING_RULES,
CreateEventSubscription.JSON_PROPERTY_NAME,
CreateEventSubscription.JSON_PROPERTY_OWNER,
CreateEventSubscription.JSON_PROPERTY_PROVIDER,
CreateEventSubscription.JSON_PROPERTY_READ_TIMEOUT,
CreateEventSubscription.JSON_PROPERTY_SUBSCRIPTION_CONFIG,
CreateEventSubscription.JSON_PROPERTY_SUBSCRIPTION_TYPE,
CreateEventSubscription.JSON_PROPERTY_TIMEOUT,
CreateEventSubscription.JSON_PROPERTY_TRIGGER
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-06-06T17:05:44.995298Z[Etc/UTC]")
public class CreateEventSubscription {
/**
* Gets or Sets alertType
*/
public enum AlertTypeEnum {
CHANGEEVENT("ChangeEvent"),
DATAINSIGHTREPORT("DataInsightReport"),
TASK_CONVERSATION_ANNOUNCEMENT("Task/Conversation/Announcement");
private String value;
AlertTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static AlertTypeEnum fromValue(String value) {
for (AlertTypeEnum b : AlertTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_ALERT_TYPE = "alertType";
private AlertTypeEnum alertType;
public static final String JSON_PROPERTY_BATCH_SIZE = "batchSize";
private Integer batchSize;
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_ENABLED = "enabled";
private Boolean enabled;
public static final String JSON_PROPERTY_EXTENSION = "extension";
private Object extension;
public static final String JSON_PROPERTY_FILTERING_RULES = "filteringRules";
private FilteringRules filteringRules;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
public static final String JSON_PROPERTY_OWNER = "owner";
private EntityReference owner;
/**
* Gets or Sets provider
*/
public enum ProviderEnum {
SYSTEM("system"),
USER("user");
private String value;
ProviderEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static ProviderEnum fromValue(String value) {
for (ProviderEnum b : ProviderEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_PROVIDER = "provider";
private ProviderEnum provider;
public static final String JSON_PROPERTY_READ_TIMEOUT = "readTimeout";
private Integer readTimeout;
public static final String JSON_PROPERTY_SUBSCRIPTION_CONFIG = "subscriptionConfig";
private Object subscriptionConfig;
/**
* Gets or Sets subscriptionType
*/
public enum SubscriptionTypeEnum {
GENERICWEBHOOK("GenericWebhook"),
SLACKWEBHOOK("SlackWebhook"),
MSTEAMSWEBHOOK("MsTeamsWebhook"),
GCHATWEBHOOK("GChatWebhook"),
EMAIL("Email"),
ACTIVITYFEED("ActivityFeed"),
DATAINSIGHT("DataInsight");
private String value;
SubscriptionTypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static SubscriptionTypeEnum fromValue(String value) {
for (SubscriptionTypeEnum b : SubscriptionTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_SUBSCRIPTION_TYPE = "subscriptionType";
private SubscriptionTypeEnum subscriptionType;
public static final String JSON_PROPERTY_TIMEOUT = "timeout";
private Integer timeout;
public static final String JSON_PROPERTY_TRIGGER = "trigger";
private TriggerConfig trigger;
public CreateEventSubscription() {
}
public CreateEventSubscription alertType(AlertTypeEnum alertType) {
this.alertType = alertType;
return this;
}
/**
* Get alertType
* @return alertType
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_ALERT_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public AlertTypeEnum getAlertType() {
return alertType;
}
@JsonProperty(JSON_PROPERTY_ALERT_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setAlertType(AlertTypeEnum alertType) {
this.alertType = alertType;
}
public CreateEventSubscription batchSize(Integer batchSize) {
this.batchSize = batchSize;
return this;
}
/**
* Get batchSize
* @return batchSize
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_BATCH_SIZE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getBatchSize() {
return batchSize;
}
@JsonProperty(JSON_PROPERTY_BATCH_SIZE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBatchSize(Integer batchSize) {
this.batchSize = batchSize;
}
public CreateEventSubscription 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 CreateEventSubscription 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 CreateEventSubscription enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* Get enabled
* @return enabled
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@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 CreateEventSubscription 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 CreateEventSubscription filteringRules(FilteringRules filteringRules) {
this.filteringRules = filteringRules;
return this;
}
/**
* Get filteringRules
* @return filteringRules
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_FILTERING_RULES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public FilteringRules getFilteringRules() {
return filteringRules;
}
@JsonProperty(JSON_PROPERTY_FILTERING_RULES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFilteringRules(FilteringRules filteringRules) {
this.filteringRules = filteringRules;
}
public CreateEventSubscription name(String name) {
this.name = name;
return this;
}
/**
* Get name
* @return name
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@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 CreateEventSubscription 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 CreateEventSubscription provider(ProviderEnum provider) {
this.provider = provider;
return this;
}
/**
* Get provider
* @return provider
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_PROVIDER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ProviderEnum getProvider() {
return provider;
}
@JsonProperty(JSON_PROPERTY_PROVIDER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setProvider(ProviderEnum provider) {
this.provider = provider;
}
public CreateEventSubscription readTimeout(Integer readTimeout) {
this.readTimeout = readTimeout;
return this;
}
/**
* Get readTimeout
* @return readTimeout
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@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 CreateEventSubscription subscriptionConfig(Object subscriptionConfig) {
this.subscriptionConfig = subscriptionConfig;
return this;
}
/**
* Get subscriptionConfig
* @return subscriptionConfig
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_SUBSCRIPTION_CONFIG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Object getSubscriptionConfig() {
return subscriptionConfig;
}
@JsonProperty(JSON_PROPERTY_SUBSCRIPTION_CONFIG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setSubscriptionConfig(Object subscriptionConfig) {
this.subscriptionConfig = subscriptionConfig;
}
public CreateEventSubscription subscriptionType(SubscriptionTypeEnum subscriptionType) {
this.subscriptionType = subscriptionType;
return this;
}
/**
* Get subscriptionType
* @return subscriptionType
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
@JsonProperty(JSON_PROPERTY_SUBSCRIPTION_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public SubscriptionTypeEnum getSubscriptionType() {
return subscriptionType;
}
@JsonProperty(JSON_PROPERTY_SUBSCRIPTION_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setSubscriptionType(SubscriptionTypeEnum subscriptionType) {
this.subscriptionType = subscriptionType;
}
public CreateEventSubscription timeout(Integer timeout) {
this.timeout = timeout;
return this;
}
/**
* Get timeout
* @return timeout
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@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 CreateEventSubscription trigger(TriggerConfig trigger) {
this.trigger = trigger;
return this;
}
/**
* Get trigger
* @return trigger
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_TRIGGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public TriggerConfig getTrigger() {
return trigger;
}
@JsonProperty(JSON_PROPERTY_TRIGGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTrigger(TriggerConfig trigger) {
this.trigger = trigger;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreateEventSubscription createEventSubscription = (CreateEventSubscription) o;
return Objects.equals(this.alertType, createEventSubscription.alertType) &&
Objects.equals(this.batchSize, createEventSubscription.batchSize) &&
Objects.equals(this.description, createEventSubscription.description) &&
Objects.equals(this.displayName, createEventSubscription.displayName) &&
Objects.equals(this.enabled, createEventSubscription.enabled) &&
Objects.equals(this.extension, createEventSubscription.extension) &&
Objects.equals(this.filteringRules, createEventSubscription.filteringRules) &&
Objects.equals(this.name, createEventSubscription.name) &&
Objects.equals(this.owner, createEventSubscription.owner) &&
Objects.equals(this.provider, createEventSubscription.provider) &&
Objects.equals(this.readTimeout, createEventSubscription.readTimeout) &&
Objects.equals(this.subscriptionConfig, createEventSubscription.subscriptionConfig) &&
Objects.equals(this.subscriptionType, createEventSubscription.subscriptionType) &&
Objects.equals(this.timeout, createEventSubscription.timeout) &&
Objects.equals(this.trigger, createEventSubscription.trigger);
}
@Override
public int hashCode() {
return Objects.hash(alertType, batchSize, description, displayName, enabled, extension, filteringRules, name, owner, provider, readTimeout, subscriptionConfig, subscriptionType, timeout, trigger);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreateEventSubscription {\n");
sb.append(" alertType: ").append(toIndentedString(alertType)).append("\n");
sb.append(" batchSize: ").append(toIndentedString(batchSize)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n");
sb.append(" extension: ").append(toIndentedString(extension)).append("\n");
sb.append(" filteringRules: ").append(toIndentedString(filteringRules)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" owner: ").append(toIndentedString(owner)).append("\n");
sb.append(" provider: ").append(toIndentedString(provider)).append("\n");
sb.append(" readTimeout: ").append(toIndentedString(readTimeout)).append("\n");
sb.append(" subscriptionConfig: ").append(toIndentedString(subscriptionConfig)).append("\n");
sb.append(" subscriptionType: ").append(toIndentedString(subscriptionType)).append("\n");
sb.append(" timeout: ").append(toIndentedString(timeout)).append("\n");
sb.append(" trigger: ").append(toIndentedString(trigger)).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 ");
}
}
