Package com.kodexa.client.remote

Class RemoteAction

java.lang.Object

com.kodexa.client.remote.AbstractKodexaConnection

com.kodexa.client.remote.AbstractKodexaSession

com.kodexa.client.remote.RemoteAction

All Implemented Interfaces:

PipelineStep

public class RemoteAction
extends AbstractKodexaSession
implements PipelineStep

A step that is hosted in the Kodexa Cloud

Field Summary

Fields inherited from class com.kodexa.client.remote.AbstractKodexaConnection

jsonOm, messagePackOm

Constructor Summary

Constructors

Constructor	Description
RemoteAction(String ref)
RemoteAction(String organizationSlug, String serviceSlug)
RemoteAction(String organizationSlug, String serviceSlug, Options options)

Method Summary

Modifier and Type	Method	Description
String	getName()	The name of the pipeline step
RemoteAction	options(Options options)
RemoteAction	parameters(Map<String,Object> parameters)
Document	process(Document document, PipelineContext pipelineContext)	The pipeline will call the process method, passing each document to the step.

Methods inherited from class com.kodexa.client.remote.AbstractKodexaSession

createSession, executeService, getOutputDocument, getRef, getTableStore, mergeStores, waitForExecution

Methods inherited from class com.kodexa.client.remote.AbstractKodexaConnection

getRequestConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAction

public RemoteAction(String organizationSlug,
                    String serviceSlug)

RemoteAction

public RemoteAction(String ref)

RemoteAction

public RemoteAction(String organizationSlug,
                    String serviceSlug,
                    Options options)

Method Detail

options

public RemoteAction options(Options options)

parameters

public RemoteAction parameters(Map<String,Object> parameters)

process

public Document process(Document document,
                        PipelineContext pipelineContext)

Description copied from interface: PipelineStep

The pipeline will call the process method, passing each document to the step. The step will then perform and actions and can return either the same document or a new document representing its result.

It can also interact with the context if it wishes to work with the stores or other contextual information.

Specified by:

process in interface PipelineStep

Parameters:

document - The document to process

pipelineContext - The pipeline's context

Returns:

The document after the steps actions

getName

public String getName()

Description copied from interface: PipelineStep

The name of the pipeline step

Specified by:

getName in interface PipelineStep

Returns:

a string representing the name