com.adobe.granite.offloading.workflow.api

Enum JobOffloadingProcessArguments

java.lang.Object

java.lang.Enum<JobOffloadingProcessArguments>

com.adobe.granite.offloading.workflow.api.JobOffloadingProcessArguments

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobOffloadingProcessArguments>

public enum JobOffloadingProcessArguments
extends java.lang.Enum<JobOffloadingProcessArguments>

Workflow process arguments for integrating job execution in workflow steps.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JOB_PROPERTIES The job properties.
JOB_TOPIC The job topic.
OFFLOADING_INPUT The offloading input.
OFFLOADING_INPUT_WORKFLOW_PAYLOAD Flag indicating if the workflow payload is supposed to be added to the offloading input.
OFFLOADING_OUTPUT The offloading output.
OFFLOADING_OUTPUT_WORKFLOW_PAYLOAD Flag indicating if the workflow payload is supposed to be added to the offloading output.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArgumentName() Get the argument name.
static JobOffloadingProcessArguments	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobOffloadingProcessArguments[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JOB_TOPIC

public static final JobOffloadingProcessArguments JOB_TOPIC

The job topic.

Mandatory. The job topic to use when adding new job.

JOB_PROPERTIES

public static final JobOffloadingProcessArguments JOB_PROPERTIES

The job properties.

Optional. Job properties are expected to be an array of key|value pairs. Key/value are expected to be separated by the pipe '|'.

OFFLOADING_INPUT

public static final JobOffloadingProcessArguments OFFLOADING_INPUT

The offloading input.

Optional. The offloading input is expected to be an array of paths.

OFFLOADING_OUTPUT

public static final JobOffloadingProcessArguments OFFLOADING_OUTPUT

The offloading output.

Optional. The offloading output is expected to be an array of paths.

OFFLOADING_INPUT_WORKFLOW_PAYLOAD

public static final JobOffloadingProcessArguments OFFLOADING_INPUT_WORKFLOW_PAYLOAD

Flag indicating if the workflow payload is supposed to be added to the offloading input.

Optional.

OFFLOADING_OUTPUT_WORKFLOW_PAYLOAD

public static final JobOffloadingProcessArguments OFFLOADING_OUTPUT_WORKFLOW_PAYLOAD

Flag indicating if the workflow payload is supposed to be added to the offloading output.

Optional.

Method Detail

values

public static JobOffloadingProcessArguments[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JobOffloadingProcessArguments c : JobOffloadingProcessArguments.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobOffloadingProcessArguments valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getArgumentName

public java.lang.String getArgumentName()

Get the argument name.

Returns:

The argument name.