org.openmetadata.client.model.SearchProfileShardResult 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.4.6-rc1
* 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.AggregationProfileShardResult;
import org.openmetadata.client.model.ProfileResult;
import org.openmetadata.client.model.QueryProfileShardResult;
import org.openmetadata.client.model.SearchProfileQueryPhaseResult;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* SearchProfileShardResult
*/
@JsonPropertyOrder({
SearchProfileShardResult.JSON_PROPERTY_AGGREGATION_PROFILE_RESULTS,
SearchProfileShardResult.JSON_PROPERTY_FETCH_PHASE,
SearchProfileShardResult.JSON_PROPERTY_FRAGMENT,
SearchProfileShardResult.JSON_PROPERTY_QUERY_PHASE,
SearchProfileShardResult.JSON_PROPERTY_QUERY_PROFILE_RESULTS
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-25T09:42:14.348793228Z[Etc/UTC]")
public class SearchProfileShardResult {
public static final String JSON_PROPERTY_AGGREGATION_PROFILE_RESULTS = "aggregationProfileResults";
private AggregationProfileShardResult aggregationProfileResults;
public static final String JSON_PROPERTY_FETCH_PHASE = "fetchPhase";
private ProfileResult fetchPhase;
public static final String JSON_PROPERTY_FRAGMENT = "fragment";
private Boolean fragment;
public static final String JSON_PROPERTY_QUERY_PHASE = "queryPhase";
private SearchProfileQueryPhaseResult queryPhase;
public static final String JSON_PROPERTY_QUERY_PROFILE_RESULTS = "queryProfileResults";
private List queryProfileResults;
public SearchProfileShardResult() {
}
public SearchProfileShardResult aggregationProfileResults(AggregationProfileShardResult aggregationProfileResults) {
this.aggregationProfileResults = aggregationProfileResults;
return this;
}
/**
* Get aggregationProfileResults
* @return aggregationProfileResults
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_AGGREGATION_PROFILE_RESULTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public AggregationProfileShardResult getAggregationProfileResults() {
return aggregationProfileResults;
}
@JsonProperty(JSON_PROPERTY_AGGREGATION_PROFILE_RESULTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAggregationProfileResults(AggregationProfileShardResult aggregationProfileResults) {
this.aggregationProfileResults = aggregationProfileResults;
}
public SearchProfileShardResult fetchPhase(ProfileResult fetchPhase) {
this.fetchPhase = fetchPhase;
return this;
}
/**
* Get fetchPhase
* @return fetchPhase
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_FETCH_PHASE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public ProfileResult getFetchPhase() {
return fetchPhase;
}
@JsonProperty(JSON_PROPERTY_FETCH_PHASE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFetchPhase(ProfileResult fetchPhase) {
this.fetchPhase = fetchPhase;
}
public SearchProfileShardResult fragment(Boolean fragment) {
this.fragment = fragment;
return this;
}
/**
* Get fragment
* @return fragment
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_FRAGMENT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Boolean getFragment() {
return fragment;
}
@JsonProperty(JSON_PROPERTY_FRAGMENT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFragment(Boolean fragment) {
this.fragment = fragment;
}
public SearchProfileShardResult queryPhase(SearchProfileQueryPhaseResult queryPhase) {
this.queryPhase = queryPhase;
return this;
}
/**
* Get queryPhase
* @return queryPhase
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_QUERY_PHASE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public SearchProfileQueryPhaseResult getQueryPhase() {
return queryPhase;
}
@JsonProperty(JSON_PROPERTY_QUERY_PHASE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setQueryPhase(SearchProfileQueryPhaseResult queryPhase) {
this.queryPhase = queryPhase;
}
public SearchProfileShardResult queryProfileResults(List queryProfileResults) {
this.queryProfileResults = queryProfileResults;
return this;
}
public SearchProfileShardResult addQueryProfileResultsItem(QueryProfileShardResult queryProfileResultsItem) {
if (this.queryProfileResults == null) {
this.queryProfileResults = new ArrayList<>();
}
this.queryProfileResults.add(queryProfileResultsItem);
return this;
}
/**
* Get queryProfileResults
* @return queryProfileResults
**/
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_QUERY_PROFILE_RESULTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getQueryProfileResults() {
return queryProfileResults;
}
@JsonProperty(JSON_PROPERTY_QUERY_PROFILE_RESULTS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setQueryProfileResults(List queryProfileResults) {
this.queryProfileResults = queryProfileResults;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
SearchProfileShardResult searchProfileShardResult = (SearchProfileShardResult) o;
return Objects.equals(this.aggregationProfileResults, searchProfileShardResult.aggregationProfileResults) &&
Objects.equals(this.fetchPhase, searchProfileShardResult.fetchPhase) &&
Objects.equals(this.fragment, searchProfileShardResult.fragment) &&
Objects.equals(this.queryPhase, searchProfileShardResult.queryPhase) &&
Objects.equals(this.queryProfileResults, searchProfileShardResult.queryProfileResults);
}
@Override
public int hashCode() {
return Objects.hash(aggregationProfileResults, fetchPhase, fragment, queryPhase, queryProfileResults);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class SearchProfileShardResult {\n");
sb.append(" aggregationProfileResults: ").append(toIndentedString(aggregationProfileResults)).append("\n");
sb.append(" fetchPhase: ").append(toIndentedString(fetchPhase)).append("\n");
sb.append(" fragment: ").append(toIndentedString(fragment)).append("\n");
sb.append(" queryPhase: ").append(toIndentedString(queryPhase)).append("\n");
sb.append(" queryProfileResults: ").append(toIndentedString(queryProfileResults)).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 ");
}
}