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.
com.atlan.api.WorkflowsEndpoint Maven / Gradle / Ivy
// Generated by delombok at Wed Oct 16 22:16:02 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.api;
import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.model.core.AtlanObject;
import com.atlan.model.workflow.*;
import com.atlan.net.ApiResource;
import com.atlan.net.RequestOptions;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import java.io.IOException;
/**
* API endpoints for operating on Atlan's workflows.
*/
public class WorkflowsEndpoint extends HeraclesEndpoint {
private static final String workflows_endpoint = "/workflows";
private static final String workflows_endpoint_run_existing = workflows_endpoint + "/submit";
private static final String workflows_search_endpoint = workflows_endpoint + "/indexsearch";
private static final String runs_endpoint = "/runs";
private static final String runs_search_endpoint = runs_endpoint + "/indexsearch";
public WorkflowsEndpoint(AtlanClient client) {
super(client);
}
/**
* Run the provided workflow.
*
* @param workflow details of the workflow to run
* @return details of the workflow run
* @throws AtlanException on any API communication issue
*/
public WorkflowResponse run(Workflow workflow) throws AtlanException {
return run(workflow, null);
}
/**
* Run the provided workflow.
*
* @param workflow details of the workflow to run
* @param options to override default client settings
* @return details of the workflow run
* @throws AtlanException on any API communication issue
*/
public WorkflowResponse run(Workflow workflow, RequestOptions options) throws AtlanException {
String url = String.format("%s%s", getBaseUrl(), String.format("%s?submit=true", workflows_endpoint));
WorkflowResponse response = ApiResource.request(client, ApiResource.RequestMethod.POST, url, workflow, WorkflowResponse.class, options);
response.setClient(client);
return response;
}
/**
* Run the provided pre-existing workflow.
*
* @param workflow details of the pre-existing workflow to re-run
* @return details of the workflow run
* @throws AtlanException on any API communication issue
*/
public WorkflowRunResponse run(WorkflowSearchResultDetail workflow) throws AtlanException {
return run(workflow, null);
}
/**
* Run the provided pre-existing workflow.
*
* @param workflow details of the pre-existing workflow to re-run
* @param options to override default client settings
* @return details of the workflow run
* @throws AtlanException on any API communication issue
*/
public WorkflowRunResponse run(WorkflowSearchResultDetail workflow, RequestOptions options) throws AtlanException {
String url = String.format("%s%s", getBaseUrl(), workflows_endpoint_run_existing);
ReRunRequest request = ReRunRequest.builder().namespace(workflow.getMetadata().getNamespace()).resourceName(workflow.getSpec().getWorkflowTemplateRef().get("name")).build();
WorkflowRunResponse response = ApiResource.request(client, ApiResource.RequestMethod.POST, url, request, WorkflowRunResponse.class, options);
response.setClient(client);
return response;
}
/**
* Stop the provided, running workflow.
*
* @param runName name of the workflow run to stop
* @return details of the stopped workflow
* @throws AtlanException on any API communication issue
*/
public WorkflowRunResponse stop(String runName) throws AtlanException {
return stop(runName, null);
}
/**
* Stop the provided, running workflow.
*
* @param runName name of the workflow run to stop
* @param options to override default client settings
* @return details of the stopped workflow
* @throws AtlanException on any API communication issue
*/
public WorkflowRunResponse stop(String runName, RequestOptions options) throws AtlanException {
String url = String.format("%s%s/%s/stop", getBaseUrl(), runs_endpoint, runName);
WorkflowRunResponse response = ApiResource.request(client, ApiResource.RequestMethod.POST, url, "", WorkflowRunResponse.class, options);
response.setClient(client);
return response;
}
/**
* Archive (delete) the provided workflow.
*
* @param workflowName the workflow to delete
* @throws AtlanException on any API communication issue
*/
public void archive(String workflowName) throws AtlanException {
archive(workflowName, null);
}
/**
* Archive (delete) the provided workflow.
*
* @param workflowName the workflow to delete
* @param options to override default client settings
* @throws AtlanException on any API communication issue
*/
public void archive(String workflowName, RequestOptions options) throws AtlanException {
String url = String.format("%s%s", getBaseUrl(), String.format("%s/%s/archive", workflows_endpoint, workflowName));
ApiResource.request(client, ApiResource.RequestMethod.POST, url, "", options);
}
/**
* Search for workflow runs that meet the provided criteria.
*
* @param request criteria by which to find workflow runs
* @return the matching workflow runs
* @throws AtlanException on any API communication issue
*/
public WorkflowSearchResponse searchRuns(WorkflowSearchRequest request) throws AtlanException {
return searchRuns(request, null);
}
/**
* Search for workflow runs that meet the provided criteria.
*
* @param request criteria by which to find workflow runs
* @param options to override default client settings
* @return the matching workflow runs
* @throws AtlanException on any API communication issue
*/
public WorkflowSearchResponse searchRuns(WorkflowSearchRequest request, RequestOptions options) throws AtlanException {
String url = String.format("%s%s", getBaseUrl(), runs_search_endpoint);
return ApiResource.request(client, ApiResource.RequestMethod.POST, url, request, WorkflowSearchResponse.class, options);
}
/**
* Search for workflows that meet the provided criteria.
*
* @param request criteria by which to find workflows
* @return the matching workflows
* @throws AtlanException on any API communication issue
*/
public WorkflowSearchResponse search(WorkflowSearchRequest request) throws AtlanException {
return search(request, null);
}
/**
* Search for workflows that meet the provided criteria.
*
* @param request criteria by which to find workflows
* @param options to override default client settings
* @return the matching workflows
* @throws AtlanException on any API communication issue
*/
public WorkflowSearchResponse search(WorkflowSearchRequest request, RequestOptions options) throws AtlanException {
String url = String.format("%s%s", getBaseUrl(), workflows_search_endpoint);
return ApiResource.request(client, ApiResource.RequestMethod.POST, url, request, WorkflowSearchResponse.class, options);
}
/**
* Update a given workflow's configuration.
*
* @param workflowName name of the workflow to update
* @param request full details of the workflow's revised configuration
* @return the updated workflow configuration
* @throws AtlanException on any API communication issue
*/
public Workflow update(String workflowName, Workflow request) throws AtlanException {
return update(workflowName, request, null);
}
/**
* Update a given workflow's configuration.
*
* @param workflowName name of the workflow to update
* @param request full details of the workflow's revised configuration
* @param options to override default client settings
* @return the updated workflow configuration
* @throws AtlanException on any API communication issue
*/
public Workflow update(String workflowName, Workflow request, RequestOptions options) throws AtlanException {
String url = String.format("%s%s/%s", getBaseUrl(), workflows_endpoint, workflowName);
WrappedWorkflow response = ApiResource.request(client, ApiResource.RequestMethod.POST, url, request, WrappedWorkflow.class, options);
if (response != null) {
Workflow workflow = response.getWorkflow();
workflow.setRawJsonObject(response.getRawJsonObject());
return workflow;
}
return null;
}
/**
* Request class for re-running a pre-existing workflow.
*/
static class ReRunRequest extends AtlanObject {
private static final long serialVersionUID = 2L;
/**
* Namespace of the workflow.
*/
String namespace;
/**
* Resource type of the workflow.
*/
String resourceKind;
/**
* Name of the workflow.
*/
String resourceName;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static String $default$namespace() {
return "default";
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static String $default$resourceKind() {
return "WorkflowTemplate";
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static abstract class ReRunRequestBuilder> extends AtlanObject.AtlanObjectBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private boolean namespace$set;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String namespace$value;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private boolean resourceKind$set;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String resourceKind$value;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private String resourceName;
/**
* Namespace of the workflow.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B namespace(final String namespace) {
this.namespace$value = namespace;
namespace$set = true;
return self();
}
/**
* Resource type of the workflow.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B resourceKind(final String resourceKind) {
this.resourceKind$value = resourceKind;
resourceKind$set = true;
return self();
}
/**
* Name of the workflow.
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B resourceName(final String resourceName) {
this.resourceName = resourceName;
return self();
}
@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 "WorkflowsEndpoint.ReRunRequest.ReRunRequestBuilder(super=" + super.toString() + ", namespace$value=" + this.namespace$value + ", resourceKind$value=" + this.resourceKind$value + ", resourceName=" + this.resourceName + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class ReRunRequestBuilderImpl extends WorkflowsEndpoint.ReRunRequest.ReRunRequestBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private ReRunRequestBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected WorkflowsEndpoint.ReRunRequest.ReRunRequestBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public WorkflowsEndpoint.ReRunRequest build() {
return new WorkflowsEndpoint.ReRunRequest(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected ReRunRequest(final WorkflowsEndpoint.ReRunRequest.ReRunRequestBuilder b) {
super(b);
if (b.namespace$set) this.namespace = b.namespace$value;
else this.namespace = WorkflowsEndpoint.ReRunRequest.$default$namespace();
if (b.resourceKind$set) this.resourceKind = b.resourceKind$value;
else this.resourceKind = WorkflowsEndpoint.ReRunRequest.$default$resourceKind();
this.resourceName = b.resourceName;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static WorkflowsEndpoint.ReRunRequest.ReRunRequestBuilder builder() {
return new WorkflowsEndpoint.ReRunRequest.ReRunRequestBuilderImpl();
}
/**
* Namespace of the workflow.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getNamespace() {
return this.namespace;
}
/**
* Resource type of the workflow.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getResourceKind() {
return this.resourceKind;
}
/**
* Name of the workflow.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getResourceName() {
return this.resourceName;
}
@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 WorkflowsEndpoint.ReRunRequest)) return false;
final WorkflowsEndpoint.ReRunRequest other = (WorkflowsEndpoint.ReRunRequest) o;
if (!other.canEqual((java.lang.Object) this)) return false;
final java.lang.Object this$namespace = this.getNamespace();
final java.lang.Object other$namespace = other.getNamespace();
if (this$namespace == null ? other$namespace != null : !this$namespace.equals(other$namespace)) return false;
final java.lang.Object this$resourceKind = this.getResourceKind();
final java.lang.Object other$resourceKind = other.getResourceKind();
if (this$resourceKind == null ? other$resourceKind != null : !this$resourceKind.equals(other$resourceKind)) return false;
final java.lang.Object this$resourceName = this.getResourceName();
final java.lang.Object other$resourceName = other.getResourceName();
if (this$resourceName == null ? other$resourceName != null : !this$resourceName.equals(other$resourceName)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof WorkflowsEndpoint.ReRunRequest;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = 1;
final java.lang.Object $namespace = this.getNamespace();
result = result * PRIME + ($namespace == null ? 43 : $namespace.hashCode());
final java.lang.Object $resourceKind = this.getResourceKind();
result = result * PRIME + ($resourceKind == null ? 43 : $resourceKind.hashCode());
final java.lang.Object $resourceName = this.getResourceName();
result = result * PRIME + ($resourceName == null ? 43 : $resourceName.hashCode());
return result;
}
}
/**
* Necessary for handling responses that are plain Workflow without any wrapping.
*/
@JsonSerialize(using = WrappedWorkflowSerializer.class)
@JsonDeserialize(using = WrappedWorkflowDeserializer.class)
private static final class WrappedWorkflow extends ApiResource {
private static final long serialVersionUID = 2L;
Workflow workflow;
public WrappedWorkflow(Workflow workflow) {
this.workflow = workflow;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Workflow getWorkflow() {
return this.workflow;
}
@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 WorkflowsEndpoint.WrappedWorkflow)) return false;
final WorkflowsEndpoint.WrappedWorkflow other = (WorkflowsEndpoint.WrappedWorkflow) o;
if (!other.canEqual((java.lang.Object) this)) return false;
final java.lang.Object this$workflow = this.getWorkflow();
final java.lang.Object other$workflow = other.getWorkflow();
if (this$workflow == null ? other$workflow != null : !this$workflow.equals(other$workflow)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof WorkflowsEndpoint.WrappedWorkflow;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = 1;
final java.lang.Object $workflow = this.getWorkflow();
result = result * PRIME + ($workflow == null ? 43 : $workflow.hashCode());
return result;
}
}
private static class WrappedWorkflowDeserializer extends StdDeserializer {
private static final long serialVersionUID = 2L;
public WrappedWorkflowDeserializer() {
this(WrappedWorkflow.class);
}
public WrappedWorkflowDeserializer(Class t) {
super(t);
}
/**
* {@inheritDoc}
*/
@Override
public WrappedWorkflow deserialize(JsonParser parser, DeserializationContext context) throws IOException {
Workflow workflow = parser.getCodec().readValue(parser, new TypeReference<>() {
});
return new WrappedWorkflow(workflow);
}
}
private static class WrappedWorkflowSerializer extends StdSerializer {
private static final long serialVersionUID = 2L;
private final AtlanClient client;
@SuppressWarnings("UnusedMethod")
public WrappedWorkflowSerializer(AtlanClient client) {
this(WrappedWorkflow.class, client);
}
public WrappedWorkflowSerializer(Class t, AtlanClient client) {
super(t);
this.client = client;
}
/**
* {@inheritDoc}
*/
@Override
public void serialize(WrappedWorkflow wrappedWorkflow, JsonGenerator gen, SerializerProvider sp) throws IOException, JsonProcessingException {
Workflow workflow = wrappedWorkflow.getWorkflow();
client.writeValue(gen, workflow);
}
}
}
