All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.openmetadata.client.model.CreateIngestionPipeline Maven / Gradle / Ivy

There is a newer version: 1.5.11
Show newest version
/*
 * 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.5
 * 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.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.openmetadata.client.model.AirflowConfig;
import org.openmetadata.client.model.EntityReference;
import org.openmetadata.client.model.LifeCycle;
import org.openmetadata.client.model.SourceConfig;
import org.openmetadata.client.model.TagLabel;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * CreateIngestionPipeline
 */
@JsonPropertyOrder({
  CreateIngestionPipeline.JSON_PROPERTY_AIRFLOW_CONFIG,
  CreateIngestionPipeline.JSON_PROPERTY_DATA_PRODUCTS,
  CreateIngestionPipeline.JSON_PROPERTY_DESCRIPTION,
  CreateIngestionPipeline.JSON_PROPERTY_DISPLAY_NAME,
  CreateIngestionPipeline.JSON_PROPERTY_DOMAIN,
  CreateIngestionPipeline.JSON_PROPERTY_EXTENSION,
  CreateIngestionPipeline.JSON_PROPERTY_LIFE_CYCLE,
  CreateIngestionPipeline.JSON_PROPERTY_LOGGER_LEVEL,
  CreateIngestionPipeline.JSON_PROPERTY_NAME,
  CreateIngestionPipeline.JSON_PROPERTY_OWNERS,
  CreateIngestionPipeline.JSON_PROPERTY_PIPELINE_TYPE,
  CreateIngestionPipeline.JSON_PROPERTY_REVIEWERS,
  CreateIngestionPipeline.JSON_PROPERTY_SERVICE,
  CreateIngestionPipeline.JSON_PROPERTY_SOURCE_CONFIG,
  CreateIngestionPipeline.JSON_PROPERTY_TAGS
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-25T06:10:38.496414726Z[Etc/UTC]")
public class CreateIngestionPipeline {
  public static final String JSON_PROPERTY_AIRFLOW_CONFIG = "airflowConfig";
  private AirflowConfig airflowConfig;

  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_EXTENSION = "extension";
  private Object extension;

  public static final String JSON_PROPERTY_LIFE_CYCLE = "lifeCycle";
  private LifeCycle lifeCycle;

  /**
   * Gets or Sets loggerLevel
   */
  public enum LoggerLevelEnum {
    DEBUG("DEBUG"),
    
    INFO("INFO"),
    
    WARN("WARN"),
    
    ERROR("ERROR");

    private String value;

    LoggerLevelEnum(String value) {
      this.value = value;
    }

    @JsonValue
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    @JsonCreator
    public static LoggerLevelEnum fromValue(String value) {
      for (LoggerLevelEnum b : LoggerLevelEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      throw new IllegalArgumentException("Unexpected value '" + value + "'");
    }
  }

  public static final String JSON_PROPERTY_LOGGER_LEVEL = "loggerLevel";
  private LoggerLevelEnum loggerLevel;

  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 pipelineType
   */
  public enum PipelineTypeEnum {
    METADATA("metadata"),
    
    USAGE("usage"),
    
    LINEAGE("lineage"),
    
    PROFILER("profiler"),
    
    TESTSUITE("TestSuite"),
    
    DATAINSIGHT("dataInsight"),
    
    ELASTICSEARCHREINDEX("elasticSearchReindex"),
    
    DBT("dbt"),
    
    APPLICATION("application");

    private String value;

    PipelineTypeEnum(String value) {
      this.value = value;
    }

    @JsonValue
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    @JsonCreator
    public static PipelineTypeEnum fromValue(String value) {
      for (PipelineTypeEnum b : PipelineTypeEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      throw new IllegalArgumentException("Unexpected value '" + value + "'");
    }
  }

  public static final String JSON_PROPERTY_PIPELINE_TYPE = "pipelineType";
  private PipelineTypeEnum pipelineType;

  public static final String JSON_PROPERTY_REVIEWERS = "reviewers";
  private List reviewers;

  public static final String JSON_PROPERTY_SERVICE = "service";
  private EntityReference service;

  public static final String JSON_PROPERTY_SOURCE_CONFIG = "sourceConfig";
  private SourceConfig sourceConfig;

  public static final String JSON_PROPERTY_TAGS = "tags";
  private List tags;

  public CreateIngestionPipeline() {
  }

  public CreateIngestionPipeline airflowConfig(AirflowConfig airflowConfig) {
    
    this.airflowConfig = airflowConfig;
    return this;
  }

   /**
   * Get airflowConfig
   * @return airflowConfig
  **/
  @javax.annotation.Nonnull
  @JsonProperty(JSON_PROPERTY_AIRFLOW_CONFIG)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public AirflowConfig getAirflowConfig() {
    return airflowConfig;
  }


  @JsonProperty(JSON_PROPERTY_AIRFLOW_CONFIG)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setAirflowConfig(AirflowConfig airflowConfig) {
    this.airflowConfig = airflowConfig;
  }


  public CreateIngestionPipeline dataProducts(List dataProducts) {
    
    this.dataProducts = dataProducts;
    return this;
  }

  public CreateIngestionPipeline 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 CreateIngestionPipeline 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 CreateIngestionPipeline 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 CreateIngestionPipeline 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 CreateIngestionPipeline 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 CreateIngestionPipeline 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 CreateIngestionPipeline loggerLevel(LoggerLevelEnum loggerLevel) {
    
    this.loggerLevel = loggerLevel;
    return this;
  }

   /**
   * Get loggerLevel
   * @return loggerLevel
  **/
  @javax.annotation.Nullable
  @JsonProperty(JSON_PROPERTY_LOGGER_LEVEL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public LoggerLevelEnum getLoggerLevel() {
    return loggerLevel;
  }


  @JsonProperty(JSON_PROPERTY_LOGGER_LEVEL)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setLoggerLevel(LoggerLevelEnum loggerLevel) {
    this.loggerLevel = loggerLevel;
  }


  public CreateIngestionPipeline 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 CreateIngestionPipeline owners(List owners) {
    
    this.owners = owners;
    return this;
  }

  public CreateIngestionPipeline 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 CreateIngestionPipeline pipelineType(PipelineTypeEnum pipelineType) {
    
    this.pipelineType = pipelineType;
    return this;
  }

   /**
   * Get pipelineType
   * @return pipelineType
  **/
  @javax.annotation.Nonnull
  @JsonProperty(JSON_PROPERTY_PIPELINE_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public PipelineTypeEnum getPipelineType() {
    return pipelineType;
  }


  @JsonProperty(JSON_PROPERTY_PIPELINE_TYPE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setPipelineType(PipelineTypeEnum pipelineType) {
    this.pipelineType = pipelineType;
  }


  public CreateIngestionPipeline reviewers(List reviewers) {
    
    this.reviewers = reviewers;
    return this;
  }

  public CreateIngestionPipeline 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 CreateIngestionPipeline service(EntityReference service) {
    
    this.service = service;
    return this;
  }

   /**
   * Get service
   * @return service
  **/
  @javax.annotation.Nonnull
  @JsonProperty(JSON_PROPERTY_SERVICE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public EntityReference getService() {
    return service;
  }


  @JsonProperty(JSON_PROPERTY_SERVICE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setService(EntityReference service) {
    this.service = service;
  }


  public CreateIngestionPipeline sourceConfig(SourceConfig sourceConfig) {
    
    this.sourceConfig = sourceConfig;
    return this;
  }

   /**
   * Get sourceConfig
   * @return sourceConfig
  **/
  @javax.annotation.Nonnull
  @JsonProperty(JSON_PROPERTY_SOURCE_CONFIG)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public SourceConfig getSourceConfig() {
    return sourceConfig;
  }


  @JsonProperty(JSON_PROPERTY_SOURCE_CONFIG)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setSourceConfig(SourceConfig sourceConfig) {
    this.sourceConfig = sourceConfig;
  }


  public CreateIngestionPipeline tags(List tags) {
    
    this.tags = tags;
    return this;
  }

  public CreateIngestionPipeline 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;
    }
    CreateIngestionPipeline createIngestionPipeline = (CreateIngestionPipeline) o;
    return Objects.equals(this.airflowConfig, createIngestionPipeline.airflowConfig) &&
        Objects.equals(this.dataProducts, createIngestionPipeline.dataProducts) &&
        Objects.equals(this.description, createIngestionPipeline.description) &&
        Objects.equals(this.displayName, createIngestionPipeline.displayName) &&
        Objects.equals(this.domain, createIngestionPipeline.domain) &&
        Objects.equals(this.extension, createIngestionPipeline.extension) &&
        Objects.equals(this.lifeCycle, createIngestionPipeline.lifeCycle) &&
        Objects.equals(this.loggerLevel, createIngestionPipeline.loggerLevel) &&
        Objects.equals(this.name, createIngestionPipeline.name) &&
        Objects.equals(this.owners, createIngestionPipeline.owners) &&
        Objects.equals(this.pipelineType, createIngestionPipeline.pipelineType) &&
        Objects.equals(this.reviewers, createIngestionPipeline.reviewers) &&
        Objects.equals(this.service, createIngestionPipeline.service) &&
        Objects.equals(this.sourceConfig, createIngestionPipeline.sourceConfig) &&
        Objects.equals(this.tags, createIngestionPipeline.tags);
  }

  @Override
  public int hashCode() {
    return Objects.hash(airflowConfig, dataProducts, description, displayName, domain, extension, lifeCycle, loggerLevel, name, owners, pipelineType, reviewers, service, sourceConfig, tags);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CreateIngestionPipeline {\n");
    sb.append("    airflowConfig: ").append(toIndentedString(airflowConfig)).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("    extension: ").append(toIndentedString(extension)).append("\n");
    sb.append("    lifeCycle: ").append(toIndentedString(lifeCycle)).append("\n");
    sb.append("    loggerLevel: ").append(toIndentedString(loggerLevel)).append("\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    owners: ").append(toIndentedString(owners)).append("\n");
    sb.append("    pipelineType: ").append(toIndentedString(pipelineType)).append("\n");
    sb.append("    reviewers: ").append(toIndentedString(reviewers)).append("\n");
    sb.append("    service: ").append(toIndentedString(service)).append("\n");
    sb.append("    sourceConfig: ").append(toIndentedString(sourceConfig)).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    ");
  }

}





© 2015 - 2024 Weber Informatics LLC | Privacy Policy