com.netflix.conductor.client.http

Class MetadataClient

java.lang.Object

com.netflix.conductor.client.http.ClientBase

com.netflix.conductor.client.http.MetadataClient

public class MetadataClient
extends ClientBase

Field Summary

Fields inherited from class com.netflix.conductor.client.http.ClientBase

client, conductorClientConfiguration, objectMapper, payloadStorage, root

Constructor Summary

Constructors

Constructor and Description
MetadataClient() Creates a default metadata client
MetadataClient(com.sun.jersey.api.client.config.ClientConfig clientConfig)
MetadataClient(com.sun.jersey.api.client.config.ClientConfig clientConfig, com.sun.jersey.api.client.ClientHandler clientHandler)
MetadataClient(com.sun.jersey.api.client.config.ClientConfig config, com.sun.jersey.api.client.ClientHandler handler, com.sun.jersey.api.client.filter.ClientFilter... filters)
MetadataClient(com.sun.jersey.api.client.config.ClientConfig config, ConductorClientConfiguration clientConfiguration, com.sun.jersey.api.client.ClientHandler handler, com.sun.jersey.api.client.filter.ClientFilter... filters)

Method Summary

Modifier and Type	Method and Description
java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef>	getAllTaskDefs() Deprecated. This API is deprecated and will be removed in the next version This API can return 503 for a large number of workflow definitions because of no pagination.
java.util.List<com.netflix.conductor.common.metadata.workflow.WorkflowDef>	getAllWorkflowDefs() Deprecated. This API is deprecated and will be removed in the next version This API can return 503 for a large number of workflow definitions because of no pagination.
com.netflix.conductor.common.metadata.tasks.TaskDef	getTaskDef(java.lang.String taskType) Retrieve the task definition of a given task type
com.netflix.conductor.common.metadata.workflow.WorkflowDef	getWorkflowDef(java.lang.String name, java.lang.Integer version) Retrieve the workflow definition
void	registerTaskDefs(java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> taskDefs) Registers a list of task types with the conductor server
void	registerWorkflowDef(com.netflix.conductor.common.metadata.workflow.WorkflowDef workflowDef) Register a workflow definition with the server
void	unregisterTaskDef(java.lang.String taskType) Removes the task definition of a task type from the conductor server.
void	unregisterWorkflowDef(java.lang.String name, java.lang.Integer version) Removes the workflow definition of a workflow from the conductor server.
void	updateTaskDef(com.netflix.conductor.common.metadata.tasks.TaskDef taskDef) Updates an existing task definition
void	updateWorkflowDefs(java.util.List<com.netflix.conductor.common.metadata.workflow.WorkflowDef> workflowDefs) Updates a list of existing workflow definitions

Methods inherited from class com.netflix.conductor.client.http.ClientBase

delete, delete, downloadFromExternalStorage, postForEntity, postForEntity, postForEntityWithRequestOnly, postForEntityWithUriVariablesOnly, put, setRootURI, uploadToExternalPayloadStorage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataClient

public MetadataClient()

Creates a default metadata client

MetadataClient

public MetadataClient(com.sun.jersey.api.client.config.ClientConfig clientConfig)

Parameters:

clientConfig - REST Client configuration

MetadataClient

public MetadataClient(com.sun.jersey.api.client.config.ClientConfig clientConfig,
                      com.sun.jersey.api.client.ClientHandler clientHandler)

Parameters:

clientConfig - REST Client configuration

clientHandler - Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

MetadataClient

public MetadataClient(com.sun.jersey.api.client.config.ClientConfig config,
                      com.sun.jersey.api.client.ClientHandler handler,
                      com.sun.jersey.api.client.filter.ClientFilter... filters)

Parameters:

config - config REST Client configuration

handler - handler Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

filters - Chain of client side filters to be applied per request

MetadataClient

public MetadataClient(com.sun.jersey.api.client.config.ClientConfig config,
                      ConductorClientConfiguration clientConfiguration,
                      com.sun.jersey.api.client.ClientHandler handler,
                      com.sun.jersey.api.client.filter.ClientFilter... filters)

Parameters:

config - REST Client configuration

clientConfiguration - Specific properties configured for the client, see ConductorClientConfiguration

handler - Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

filters - Chain of client side filters to be applied per request

Method Detail

registerWorkflowDef

public void registerWorkflowDef(com.netflix.conductor.common.metadata.workflow.WorkflowDef workflowDef)

Register a workflow definition with the server

Parameters:

workflowDef - the workflow definition

updateWorkflowDefs

public void updateWorkflowDefs(java.util.List<com.netflix.conductor.common.metadata.workflow.WorkflowDef> workflowDefs)

Updates a list of existing workflow definitions

Parameters:

workflowDefs - List of workflow definitions to be updated

getWorkflowDef

public com.netflix.conductor.common.metadata.workflow.WorkflowDef getWorkflowDef(java.lang.String name,
                                                                                 java.lang.Integer version)

Retrieve the workflow definition

Parameters:

name - the name of the workflow

version - the version of the workflow def

Returns:

Workflow definition for the given workflow and version

getAllWorkflowDefs

@Deprecated
public java.util.List<com.netflix.conductor.common.metadata.workflow.WorkflowDef> getAllWorkflowDefs()

Deprecated. This API is deprecated and will be removed in the next version This API can return 503 for a large number of workflow definitions because of no pagination.

unregisterWorkflowDef

public void unregisterWorkflowDef(java.lang.String name,
                                  java.lang.Integer version)

Removes the workflow definition of a workflow from the conductor server. It does not remove associated workflows. Use with caution.

Parameters:

name - Name of the workflow to be unregistered.

version - Version of the workflow definition to be unregistered.

registerTaskDefs

public void registerTaskDefs(java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> taskDefs)

Registers a list of task types with the conductor server

Parameters:

taskDefs - List of task types to be registered.

updateTaskDef

public void updateTaskDef(com.netflix.conductor.common.metadata.tasks.TaskDef taskDef)

Updates an existing task definition

Parameters:

taskDef - the task definition to be updated

getAllTaskDefs

@Deprecated
public java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> getAllTaskDefs()

Deprecated. This API is deprecated and will be removed in the next version This API can return 503 for a large number of workflow definitions because of no pagination.

getTaskDef

public com.netflix.conductor.common.metadata.tasks.TaskDef getTaskDef(java.lang.String taskType)

Retrieve the task definition of a given task type

Parameters:

taskType - type of task for which to retrieve the definition

Returns:

Task Definition for the given task type

unregisterTaskDef

public void unregisterTaskDef(java.lang.String taskType)

Removes the task definition of a task type from the conductor server. Use with caution.

Parameters:

taskType - Task type to be unregistered.