org.openmetadata.client.api.WorkflowDefinitionsApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import org.openmetadata.client.model.APICollection;
import org.openmetadata.client.model.CreateWorkflowDefinition;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import java.util.UUID;
import org.openmetadata.client.model.WorkflowDefinition;
import org.openmetadata.client.model.WorkflowDefinitionList;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-11-20T14:35:21.920766473Z[Etc/UTC]")
public interface WorkflowDefinitionsApi extends ApiClient.Api {
/**
* Create or update Workflow Definition
* Create a Workflow Definition, if it does not exist or update an existing Workflow Definition.
* @param createWorkflowDefinition (optional)
* @return APICollection
*/
@RequestLine("PUT /v1/governance/workflowDefinitions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
APICollection createOrUpdateWorkflowDefinition(CreateWorkflowDefinition createWorkflowDefinition);
/**
* Create or update Workflow Definition
* Similar to createOrUpdateWorkflowDefinition but it also returns the http response headers .
* Create a Workflow Definition, if it does not exist or update an existing Workflow Definition.
* @param createWorkflowDefinition (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/governance/workflowDefinitions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateWorkflowDefinitionWithHttpInfo(CreateWorkflowDefinition createWorkflowDefinition);
/**
* Create a Workflow Definition
* Create a Workflow Definition.
* @param createWorkflowDefinition (optional)
* @return WorkflowDefinition
*/
@RequestLine("POST /v1/governance/workflowDefinitions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
WorkflowDefinition createWorkflowDefinition(CreateWorkflowDefinition createWorkflowDefinition);
/**
* Create a Workflow Definition
* Similar to createWorkflowDefinition but it also returns the http response headers .
* Create a Workflow Definition.
* @param createWorkflowDefinition (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/governance/workflowDefinitions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createWorkflowDefinitionWithHttpInfo(CreateWorkflowDefinition createWorkflowDefinition);
/**
* Delete a Workflow Definition by fully qualified name
* Delete a Workflow Definition by `fullyQualifiedName`.
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param hardDelete Hard delete the entity. (default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteAPICollectionByFQN1(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a Workflow Definition by fully qualified name
* Similar to deleteAPICollectionByFQN1 but it also returns the http response headers .
* Delete a Workflow Definition by `fullyQualifiedName`.
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param hardDelete Hard delete the entity. (default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteAPICollectionByFQN1WithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a Workflow Definition by fully qualified name
* Delete a Workflow Definition by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteAPICollectionByFQN1 method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteAPICollectionByFQN1QueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteAPICollectionByFQN1(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteAPICollectionByFQN1QueryParams queryParams);
/**
* Delete a Workflow Definition by fully qualified name
* Delete a Workflow Definition by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteAPICollectionByFQN1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteAPICollectionByFQN1WithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteAPICollectionByFQN1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteAPICollectionByFQN1 method in a fluent style.
*/
public static class DeleteAPICollectionByFQN1QueryParams extends HashMap {
public DeleteAPICollectionByFQN1QueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeleteAPICollectionByFQN1QueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a Workflow Definition by Id
* Delete a Workflow Definition by `Id`.
* @param id Id of the Workflow Definition (required)
* @param recursive Recursively delete this entity and it's children. (default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteWorkflowDefinition(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a Workflow Definition by Id
* Similar to deleteWorkflowDefinition but it also returns the http response headers .
* Delete a Workflow Definition by `Id`.
* @param id Id of the Workflow Definition (required)
* @param recursive Recursively delete this entity and it's children. (default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteWorkflowDefinitionWithHttpInfo(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a Workflow Definition by Id
* Delete a Workflow Definition by `Id`.
* Note, this is equivalent to the other deleteWorkflowDefinition method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteWorkflowDefinitionQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteWorkflowDefinition(@Param("id") UUID id, @QueryMap(encoded=true) DeleteWorkflowDefinitionQueryParams queryParams);
/**
* Delete a Workflow Definition by Id
* Delete a Workflow Definition by `Id`.
* Note, this is equivalent to the other deleteWorkflowDefinition that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/governance/workflowDefinitions/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteWorkflowDefinitionWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteWorkflowDefinitionQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteWorkflowDefinition method in a fluent style.
*/
public static class DeleteWorkflowDefinitionQueryParams extends HashMap {
public DeleteWorkflowDefinitionQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
public DeleteWorkflowDefinitionQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the Workflow Definition
* Get a version of the Workflow Definition by given `Id`
* @param id Id of the Workflow Definition (required)
* @param version APICollection version number in the form `major`.`minor` (required)
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
APICollection getSpecificWorkflowDefinitionVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the Workflow Definition
* Similar to getSpecificWorkflowDefinitionVersion but it also returns the http response headers .
* Get a version of the Workflow Definition by given `Id`
* @param id Id of the Workflow Definition (required)
* @param version APICollection version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificWorkflowDefinitionVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get a Workflow Definition by fully qualified name
* Get a Workflow Definition by `fullyQualifiedName`.
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
APICollection getWorkflowDefinitionByFQN(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a Workflow Definition by fully qualified name
* Similar to getWorkflowDefinitionByFQN but it also returns the http response headers .
* Get a Workflow Definition by `fullyQualifiedName`.
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/governance/workflowDefinitions/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWorkflowDefinitionByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a Workflow Definition by fully qualified name
* Get a Workflow Definition by `fullyQualifiedName`.
* Note, this is equivalent to the other getWorkflowDefinitionByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetWorkflowDefinitionByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
APICollection getWorkflowDefinitionByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) GetWorkflowDefinitionByFQNQueryParams queryParams);
/**
* Get a Workflow Definition by fully qualified name
* Get a Workflow Definition by `fullyQualifiedName`.
* Note, this is equivalent to the other getWorkflowDefinitionByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWorkflowDefinitionByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) GetWorkflowDefinitionByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getWorkflowDefinitionByFQN method in a fluent style.
*/
public static class GetWorkflowDefinitionByFQNQueryParams extends HashMap {
public GetWorkflowDefinitionByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetWorkflowDefinitionByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a Workflow Definition by Id
* Get a Workflow Definition by `Id`.
* @param id Id of the Workflow Definition (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
APICollection getWorkflowDefinitionByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a Workflow Definition by Id
* Similar to getWorkflowDefinitionByID but it also returns the http response headers .
* Get a Workflow Definition by `Id`.
* @param id Id of the Workflow Definition (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWorkflowDefinitionByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a Workflow Definition by Id
* Get a Workflow Definition by `Id`.
* Note, this is equivalent to the other getWorkflowDefinitionByID method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetWorkflowDefinitionByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
APICollection getWorkflowDefinitionByID(@Param("id") UUID id, @QueryMap(encoded=true) GetWorkflowDefinitionByIDQueryParams queryParams);
/**
* Get a Workflow Definition by Id
* Get a Workflow Definition by `Id`.
* Note, this is equivalent to the other getWorkflowDefinitionByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the Workflow Definition (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return APICollection
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWorkflowDefinitionByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetWorkflowDefinitionByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getWorkflowDefinitionByID method in a fluent style.
*/
public static class GetWorkflowDefinitionByIDQueryParams extends HashMap {
public GetWorkflowDefinitionByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetWorkflowDefinitionByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* List Workflow Definition versions
* Get a list of all the versions of a Workflow Definition identified by `Id`
* @param id Id of the Workflow Definition (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllWorkflowDefinitionVersion(@Param("id") UUID id);
/**
* List Workflow Definition versions
* Similar to listAllWorkflowDefinitionVersion but it also returns the http response headers .
* Get a list of all the versions of a Workflow Definition identified by `Id`
* @param id Id of the Workflow Definition (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/governance/workflowDefinitions/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllWorkflowDefinitionVersionWithHttpInfo(@Param("id") UUID id);
/**
* List Workflow Definitions
* Get a list of Workflow Definitions. Use `fields` parameter to get only necessary fields. Use cursor-based pagination tom limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number of Workflow Definitions returned. Default = 10) (optional, default to 10)
* @param before Returns the list of Workflow Definitions before this cursor (optional)
* @param after Returns the list of Workflow Definitions after this cursor (optional)
* @param include Include all, deleted or non-deleted entities. (optional, default to non-deleted)
* @return WorkflowDefinitionList
*/
@RequestLine("GET /v1/governance/workflowDefinitions?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
WorkflowDefinitionList listWorkflowDefinitions(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List Workflow Definitions
* Similar to listWorkflowDefinitions but it also returns the http response headers .
* Get a list of Workflow Definitions. Use `fields` parameter to get only necessary fields. Use cursor-based pagination tom limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number of Workflow Definitions returned. Default = 10) (optional, default to 10)
* @param before Returns the list of Workflow Definitions before this cursor (optional)
* @param after Returns the list of Workflow Definitions after this cursor (optional)
* @param include Include all, deleted or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/governance/workflowDefinitions?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listWorkflowDefinitionsWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List Workflow Definitions
* Get a list of Workflow Definitions. Use `fields` parameter to get only necessary fields. Use cursor-based pagination tom limit the number of entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listWorkflowDefinitions method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListWorkflowDefinitionsQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - limit - Limit the number of Workflow Definitions returned. Default = 10) (optional, default to 10)
* - before - Returns the list of Workflow Definitions before this cursor (optional)
* - after - Returns the list of Workflow Definitions after this cursor (optional)
* - include - Include all, deleted or non-deleted entities. (optional, default to non-deleted)
*
* @return WorkflowDefinitionList
*/
@RequestLine("GET /v1/governance/workflowDefinitions?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
WorkflowDefinitionList listWorkflowDefinitions(@QueryMap(encoded=true) ListWorkflowDefinitionsQueryParams queryParams);
/**
* List Workflow Definitions
* Get a list of Workflow Definitions. Use `fields` parameter to get only necessary fields. Use cursor-based pagination tom limit the number of entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listWorkflowDefinitions that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - limit - Limit the number of Workflow Definitions returned. Default = 10) (optional, default to 10)
* - before - Returns the list of Workflow Definitions before this cursor (optional)
* - after - Returns the list of Workflow Definitions after this cursor (optional)
* - include - Include all, deleted or non-deleted entities. (optional, default to non-deleted)
*
* @return WorkflowDefinitionList
*/
@RequestLine("GET /v1/governance/workflowDefinitions?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listWorkflowDefinitionsWithHttpInfo(@QueryMap(encoded=true) ListWorkflowDefinitionsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listWorkflowDefinitions method in a fluent style.
*/
public static class ListWorkflowDefinitionsQueryParams extends HashMap {
public ListWorkflowDefinitionsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListWorkflowDefinitionsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListWorkflowDefinitionsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListWorkflowDefinitionsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListWorkflowDefinitionsQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a Workflow Definition by name.
* Update an existing Workflow Definition using JsonPatch.
* @param fqn Name of the Workflow Definition (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Workflow Definition by name. Documentation
*/
@RequestLine("PATCH /v1/governance/workflowDefinitions/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchWorkflowDefinition(@Param("fqn") String fqn, Object body);
/**
* Update a Workflow Definition by name.
* Similar to patchWorkflowDefinition but it also returns the http response headers .
* Update an existing Workflow Definition using JsonPatch.
* @param fqn Name of the Workflow Definition (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Workflow Definition by name. Documentation
*/
@RequestLine("PATCH /v1/governance/workflowDefinitions/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchWorkflowDefinitionWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a Workflow Definition by Id
* Update an existing Workflow Definition using JsonPatch.
* @param id Id of the Workflow Definition (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Workflow Definition by Id Documentation
*/
@RequestLine("PATCH /v1/governance/workflowDefinitions/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchWorkflowDefinition1(@Param("id") UUID id, Object body);
/**
* Update a Workflow Definition by Id
* Similar to patchWorkflowDefinition1 but it also returns the http response headers .
* Update an existing Workflow Definition using JsonPatch.
* @param id Id of the Workflow Definition (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Workflow Definition by Id Documentation
*/
@RequestLine("PATCH /v1/governance/workflowDefinitions/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchWorkflowDefinition1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted Workflow Definition.
* Restore a soft deleted Workflow Definition.
* @param restoreEntity (optional)
* @return WorkflowDefinition
*/
@RequestLine("PUT /v1/governance/workflowDefinitions/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
WorkflowDefinition restore17(RestoreEntity restoreEntity);
/**
* Restore a soft deleted Workflow Definition.
* Similar to restore17 but it also returns the http response headers .
* Restore a soft deleted Workflow Definition.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/governance/workflowDefinitions/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore17WithHttpInfo(RestoreEntity restoreEntity);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy