io.cdap.cdap.api.customaction

Interface CustomActionContext

All Superinterfaces:

DatasetContext, FeatureFlagsProvider, LineageRecorder, MessagingContext, MetadataReader, MetadataWriter, PluginContext, RuntimeContext, SchedulableProgramContext, SecureStore, ServiceDiscoverer, Transactional, WorkflowInfoProvider

public interface CustomActionContext
extends SchedulableProgramContext, RuntimeContext, DatasetContext, Transactional, WorkflowInfoProvider, PluginContext, SecureStore, ServiceDiscoverer, MessagingContext, MetadataReader, MetadataWriter, LineageRecorder

Represents runtime context of the CustomAction in the Workflow.

Method Summary

Modifier and Type	Method and Description
long	getLogicalStartTime() Returns the logical start time of the batch job which triggers this instance of an action.
CustomActionSpecification	getSpecification() Return the specification of the custom action.
ProgramState	getState() Return the state of the custom action.

Methods inherited from interface io.cdap.cdap.api.SchedulableProgramContext

getTriggeringScheduleInfo

Methods inherited from interface io.cdap.cdap.api.RuntimeContext

getAdmin, getApplicationSpecification, getClusterName, getDataTracer, getNamespace, getRunId, getRuntimeArguments

Methods inherited from interface io.cdap.cdap.api.data.DatasetContext

discardDataset, getDataset, getDataset, getDataset, getDataset, releaseDataset

Methods inherited from interface io.cdap.cdap.api.Transactional

execute, execute

Methods inherited from interface io.cdap.cdap.api.workflow.WorkflowInfoProvider

getWorkflowInfo, getWorkflowToken

Methods inherited from interface io.cdap.cdap.api.plugin.PluginContext

getPluginProperties, getPluginProperties, loadPluginClass, newPluginInstance, newPluginInstance

Methods inherited from interface io.cdap.cdap.api.feature.FeatureFlagsProvider

isFeatureEnabled

Methods inherited from interface io.cdap.cdap.api.security.store.SecureStore

get, getData, getMetadata, list

Methods inherited from interface io.cdap.cdap.api.ServiceDiscoverer

getServiceURL, getServiceURL, getServiceURL, openConnection

Methods inherited from interface io.cdap.cdap.api.messaging.MessagingContext

getDirectMessagePublisher, getMessageFetcher, getMessagePublisher

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataReader

getMetadata, getMetadata

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataWriter

addProperties, addTags, addTags, removeMetadata, removeProperties, removeProperties, removeTags, removeTags

Methods inherited from interface io.cdap.cdap.api.lineage.field.LineageRecorder

flushLineage, record

Method Detail

getSpecification

CustomActionSpecification getSpecification()

Return the specification of the custom action.

getLogicalStartTime

long getLogicalStartTime()

Returns the logical start time of the batch job which triggers this instance of an action. Logical start time is the time when the triggering Batch job is supposed to start if it is started by the scheduler. Otherwise it would be the current time when the action runs.

getState

ProgramState getState()

Return the state of the custom action.