com.atlan.model.workflow.WorkflowSearchRequest Maven / Gradle / Ivy
// Generated by delombok at Thu Oct 10 18:56:32 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.model.workflow;
import co.elastic.clients.elasticsearch._types.FieldSort;
import co.elastic.clients.elasticsearch._types.NestedSortValue;
import co.elastic.clients.elasticsearch._types.SortOptions;
import co.elastic.clients.elasticsearch._types.SortOrder;
import co.elastic.clients.elasticsearch._types.query_dsl.*;
import com.atlan.Atlan;
import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.model.enums.AtlanPackageType;
import com.atlan.model.enums.AtlanWorkflowPhase;
import com.atlan.model.search.IndexSearchDSL;
import java.util.List;
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = WorkflowSearchRequest.WorkflowSearchRequestBuilderImpl.class)
public class WorkflowSearchRequest extends IndexSearchDSL {
private static final long serialVersionUID = 2L;
/**
* Run the search.
*
* @return results from running the search
* @throws AtlanException on any API communication issue
*/
public WorkflowSearchResponse search() throws AtlanException {
return search(Atlan.getDefaultClient());
}
/**
* Run the search.
*
* @param client connectivity to the Atlan tenant on which to run the search
* @return results from running the search
* @throws AtlanException on any API communication issue
*/
public WorkflowSearchResponse search(AtlanClient client) throws AtlanException {
return client.workflows.searchRuns(this);
}
/**
* Find the latest run of a given workflow.
*
* @param workflowName name of the workflow for which to find the latest run
* @return the singular result giving the latest run of the workflow
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findLatestRun(String workflowName) throws AtlanException {
return findLatestRun(Atlan.getDefaultClient(), workflowName);
}
/**
* Find the latest run of a given workflow.
*
* @param client connectivity to the Atlan tenant on which to find the latest run of the workflow
* @param workflowName name of the workflow for which to find the latest run
* @return the singular result giving the latest run of the workflow
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findLatestRun(AtlanClient client, String workflowName) throws AtlanException {
SortOptions sort = SortOptions.of(s -> s.field(FieldSort.of(f -> f.field("metadata.creationTimestamp").order(SortOrder.Desc).nested(NestedSortValue.of(v -> v.path("metadata"))))));
Query term = TermQuery.of(t -> t.field("spec.workflowTemplateRef.name.keyword").value(workflowName))._toQuery();
Query nested = NestedQuery.of(n -> n.path("spec").query(term))._toQuery();
Query query = BoolQuery.of(b -> b.filter(nested))._toQuery();
WorkflowSearchRequest request = WorkflowSearchRequest.builder().from(0).size(10).sortOption(sort).query(query).build();
WorkflowSearchResponse response = client.workflows.searchRuns(request);
if (response != null) {
List results = response.getHits().getHits();
if (results != null && !results.isEmpty()) {
return results.get(0);
}
}
return null;
}
/**
* Find the most current, still-running run of a given workflow.
*
* @param client connectivity to the Atlan tenant on which to find the current run of the workflow
* @param workflowName name of the workflow for which to find the current run
* @return the singular result giving the latest currently-running run of the workflow, or null if it is not currently running
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findCurrentRun(AtlanClient client, String workflowName) throws AtlanException {
SortOptions sort = SortOptions.of(s -> s.field(FieldSort.of(f -> f.field("metadata.creationTimestamp").order(SortOrder.Desc).nested(NestedSortValue.of(v -> v.path("metadata"))))));
Query name = TermQuery.of(t -> t.field("spec.workflowTemplateRef.name.keyword").value(workflowName))._toQuery();
Query byName = NestedQuery.of(n -> n.path("spec").query(name))._toQuery();
Query query = BoolQuery.of(b -> b.filter(byName))._toQuery();
WorkflowSearchRequest request = WorkflowSearchRequest.builder().from(0).size(50).sortOption(sort).query(query).build();
WorkflowSearchResponse response = client.workflows.searchRuns(request);
if (response != null) {
List results = response.getHits().getHits();
if (results != null && !results.isEmpty()) {
for (WorkflowSearchResult result : results) {
if (result.getStatus() == AtlanWorkflowPhase.RUNNING || result.getStatus() == AtlanWorkflowPhase.PENDING) {
return result;
}
}
}
}
return null;
}
/**
* Find a specific run of a given workflow.
*
* @param workflowRunName name of the specific workflow run to find
* @return the singular result giving the specific run of the workflow
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findRunByName(String workflowRunName) throws AtlanException {
return findRunByName(Atlan.getDefaultClient(), workflowRunName);
}
/**
* Find a specific run of a given workflow.
*
* @param client connectivity to the Atlan tenant on which to find a specific run of the workflow
* @param workflowRunName name of the specific workflow run to find
* @return the singular result giving the specific run of the workflow
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findRunByName(AtlanClient client, String workflowRunName) throws AtlanException {
SortOptions sort = SortOptions.of(s -> s.field(FieldSort.of(f -> f.field("metadata.creationTimestamp").order(SortOrder.Desc).nested(NestedSortValue.of(v -> v.path("metadata"))))));
Query term = TermQuery.of(t -> t.field("metadata.name.keyword").value(workflowRunName))._toQuery();
Query nested = NestedQuery.of(n -> n.path("metadata").query(term))._toQuery();
Query query = BoolQuery.of(b -> b.filter(nested))._toQuery();
WorkflowSearchRequest request = WorkflowSearchRequest.builder().from(0).size(10).sortOption(sort).query(query).build();
WorkflowSearchResponse response = client.workflows.searchRuns(request);
if (response != null) {
List results = response.getHits().getHits();
if (results != null && !results.isEmpty()) {
return results.get(0);
}
}
return null;
}
/**
* Find workflows based on their type.
*
* @param type of the workflow
* @param maxResults the maximum number of results to retrieve
* @return the list of workflows of the provided type, with the most-recently created first
* @throws AtlanException on any API communication issue
*/
public static List findByType(AtlanPackageType type, int maxResults) throws AtlanException {
return findByType(Atlan.getDefaultClient(), type, maxResults);
}
/**
* Find workflows based on their type.
*
* @param client connectivity to the Atlan tenant on which to find the workflows
* @param type of the workflow
* @param maxResults the maximum number of results to retrieve
* @return the list of workflows of the provided type, with the most-recently created first
* @throws AtlanException on any API communication issue
*/
public static List findByType(AtlanClient client, AtlanPackageType type, int maxResults) throws AtlanException {
return findByPrefix(client, type.getValue(), maxResults);
}
/**
* Find a workflow based on is ID (e.g. {@code atlan-snowflake-miner-1714638976}).
* Note: only workflows that have been run will be found.
*
* @param id unique identifier of the specific workflow to find
* @return singular result containing the workflow, or null if not found
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findById(String id) throws AtlanException {
return findById(Atlan.getDefaultClient(), id);
}
/**
* Find a workflow based on is ID (e.g. {@code atlan-snowflake-miner-1714638976}).
* Note: only workflows that have been run will be found.
*
* @param client connectivity to the Atlan tenant on which to find the workflow
* @param id unique identifier of the specific workflow to find
* @return singular result containing the workflow, or null if not found
* @throws AtlanException on any API communication issue
*/
public static WorkflowSearchResult findById(AtlanClient client, String id) throws AtlanException {
Query term = TermQuery.of(t -> t.field("metadata.name.keyword").value(id))._toQuery();
Query nested = NestedQuery.of(n -> n.path("metadata").query(term))._toQuery();
Query query = BoolQuery.of(b -> b.filter(nested))._toQuery();
WorkflowSearchRequest request = WorkflowSearchRequest.builder().from(0).size(2).query(query).build();
WorkflowSearchResponse response = client.workflows.search(request);
if (response != null && response.getHits() != null && !response.getHits().getHits().isEmpty()) {
return response.getHits().getHits().get(0);
}
return null;
}
/**
* Find workflows based on their type.
*
* @param client connectivity to the Atlan tenant on which to find the workflows
* @param prefix of the workflow
* @param maxResults the maximum number of results to retrieve
* @return the list of workflows of the provided type, with the most-recently created first
* @throws AtlanException on any API communication issue
*/
private static List findByPrefix(AtlanClient client, String prefix, int maxResults) throws AtlanException {
SortOptions sort = SortOptions.of(s -> s.field(FieldSort.of(f -> f.field("metadata.creationTimestamp").order(SortOrder.Desc).nested(NestedSortValue.of(v -> v.path("metadata"))))));
Query term = PrefixQuery.of(t -> t.field("metadata.name.keyword").value(prefix))._toQuery();
Query nested = NestedQuery.of(n -> n.path("metadata").query(term))._toQuery();
Query query = BoolQuery.of(b -> b.filter(nested))._toQuery();
WorkflowSearchRequest request = WorkflowSearchRequest.builder().from(0).size(maxResults).sortOption(sort).query(query).build();
WorkflowSearchResponse response = client.workflows.search(request);
if (response != null && response.getHits() != null) {
return response.getHits().getHits();
}
return null;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static abstract class WorkflowSearchRequestBuilder> extends IndexSearchDSL.IndexSearchDSLBuilder {
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected abstract B self();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public abstract C build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "WorkflowSearchRequest.WorkflowSearchRequestBuilder(super=" + super.toString() + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "", buildMethodName = "build")
static final class WorkflowSearchRequestBuilderImpl extends WorkflowSearchRequest.WorkflowSearchRequestBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private WorkflowSearchRequestBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected WorkflowSearchRequest.WorkflowSearchRequestBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public WorkflowSearchRequest build() {
return new WorkflowSearchRequest(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected WorkflowSearchRequest(final WorkflowSearchRequest.WorkflowSearchRequestBuilder b) {
super(b);
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static WorkflowSearchRequest.WorkflowSearchRequestBuilder builder() {
return new WorkflowSearchRequest.WorkflowSearchRequestBuilderImpl();
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof WorkflowSearchRequest)) return false;
final WorkflowSearchRequest other = (WorkflowSearchRequest) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof WorkflowSearchRequest;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int result = super.hashCode();
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "WorkflowSearchRequest(super=" + super.toString() + ")";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy