org.openmetadata.client.model.CustomProperty 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.5.0-rc2
* 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 org.openmetadata.client.model.CustomPropertyConfig;
import org.openmetadata.client.model.EntityReference;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* CustomProperty
*/
@JsonPropertyOrder({
CustomProperty.JSON_PROPERTY_CUSTOM_PROPERTY_CONFIG,
CustomProperty.JSON_PROPERTY_DESCRIPTION,
CustomProperty.JSON_PROPERTY_NAME,
CustomProperty.JSON_PROPERTY_PROPERTY_TYPE
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-22T14:05:58.429779152Z[Etc/UTC]")
public class CustomProperty {
public static final String JSON_PROPERTY_CUSTOM_PROPERTY_CONFIG = "customPropertyConfig";
private CustomPropertyConfig customPropertyConfig;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
public static final String JSON_PROPERTY_PROPERTY_TYPE = "propertyType";
private EntityReference propertyType;
public CustomProperty() {
}
public CustomProperty customPropertyConfig(CustomPropertyConfig customPropertyConfig) {
this.customPropertyConfig = customPropertyConfig;
return this;
}
/**
* Get customPropertyConfig
* @return customPropertyConfig
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CUSTOM_PROPERTY_CONFIG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CustomPropertyConfig getCustomPropertyConfig() {
return customPropertyConfig;
}
@JsonProperty(JSON_PROPERTY_CUSTOM_PROPERTY_CONFIG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCustomPropertyConfig(CustomPropertyConfig customPropertyConfig) {
this.customPropertyConfig = customPropertyConfig;
}
public CustomProperty description(String description) {
this.description = description;
return this;
}
/**
* Get description
* @return description
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public String getDescription() {
return description;
}
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setDescription(String description) {
this.description = description;
}
public CustomProperty 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 CustomProperty propertyType(EntityReference propertyType) {
this.propertyType = propertyType;
return this;
}
/**
* Get propertyType
* @return propertyType
**/
@javax.annotation.Nonnull
@JsonProperty(JSON_PROPERTY_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public EntityReference getPropertyType() {
return propertyType;
}
@JsonProperty(JSON_PROPERTY_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public void setPropertyType(EntityReference propertyType) {
this.propertyType = propertyType;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CustomProperty customProperty = (CustomProperty) o;
return Objects.equals(this.customPropertyConfig, customProperty.customPropertyConfig) &&
Objects.equals(this.description, customProperty.description) &&
Objects.equals(this.name, customProperty.name) &&
Objects.equals(this.propertyType, customProperty.propertyType);
}
@Override
public int hashCode() {
return Objects.hash(customPropertyConfig, description, name, propertyType);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CustomProperty {\n");
sb.append(" customPropertyConfig: ").append(toIndentedString(customPropertyConfig)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" propertyType: ").append(toIndentedString(propertyType)).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 ");
}
}