Package org.apache.pinot.common.messages

Class RunPeriodicTaskMessage

java.lang.Object

org.apache.helix.HelixProperty

org.apache.helix.model.Message

org.apache.pinot.common.messages.RunPeriodicTaskMessage

public class RunPeriodicTaskMessage
extends org.apache.helix.model.Message

Upon receiving this message, Controller will execute the specified PeriodicTask against the tables for which it is the lead controller. The message is sent whenever API call for executing a PeriodicTask is invoked.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.helix.model.Message

org.apache.helix.model.Message.Attributes, org.apache.helix.model.Message.MessageState, org.apache.helix.model.Message.MessageType

Nested classes/interfaces inherited from class org.apache.helix.HelixProperty

org.apache.helix.HelixProperty.HelixPropertyAttribute, org.apache.helix.HelixProperty.Stat

Field Summary

Fields

Modifier and Type	Field	Description
static String	RUN_PERIODIC_TASK_MSG_SUB_TYPE

Fields inherited from class org.apache.helix.model.Message

CREATE_TIME_COMPARATOR, MESSAGE_EXPECT_COMPLETION_PERIOD, RELAY_MESSAGE_DEFAULT_EXPIRY

Fields inherited from class org.apache.helix.HelixProperty

_record

Constructor Summary

Constructors

Constructor	Description
RunPeriodicTaskMessage(String taskRequestId, String periodicTaskName, String tableNameWithType, Map<String,String> taskProperties)
RunPeriodicTaskMessage(org.apache.helix.model.Message message)

Method Summary

Modifier and Type	Method	Description
String	getPeriodicTaskName()
String	getPeriodicTaskRequestId()
String	getTableNameWithType()
Map<String,String>	getTaskProperties()

Methods inherited from class org.apache.helix.model.Message

addPartitionName, attachRelayMessage, createReplyMessage, getAttribute, getBucketSize, getCompletionDueTimeStamp, getCorrelationId, getCreateTimeStamp, getDebug, getExecuteStartTimeStamp, getExecutionSessionId, getExecutionTimeout, getExpiryPeriod, getFromState, getGeneration, getKey, getMsgId, getMsgSrc, getMsgState, getMsgSubType, getMsgType, getPartitionName, getPartitionNames, getReadTimeStamp, getRelayMessage, getRelayMessages, getRelaySrcHost, getRelayTime, getResourceGroupName, getResourceName, getResourceTag, getResultMap, getRetryCount, getSrcClusterName, getSrcInstanceType, getSrcSessionId, getStateModelDef, getStateModelFactoryName, getTgtName, getTgtSessionId, getToState, hasRelayMessages, isControlerMsg, isExpired, isParticipantStatusChangeType, isRelayMessage, isValid, setAttribute, setBucketSize, setCompletionDueTimeStamp, setCorrelationId, setCreateTimeStamp, setExecuteSessionId, setExecuteStartTimeStamp, setExecutionTimeout, setExpectedSessionId, setExpired, setExpiryPeriod, setFromState, setMsgId, setMsgState, setMsgSubType, setPartitionName, setReadTimeStamp, setRelayTime, setResourceGroupName, setResourceName, setResourceTag, setResultMap, setRetryCount, setSrcClusterName, setSrcInstanceType, setSrcName, setSrcSessionId, setStateModelDef, setStateModelFactoryName, setTgtName, setTgtSessionId, setToState

Methods inherited from class org.apache.helix.HelixProperty

convertListToMap, convertToList, convertToTypedInstance, convertToTypedList, equals, getBatchMessageMode, getId, getRecord, getStat, serialize, setBatchMessageMode, setDeltaList, setStat, toString

Methods inherited from class java.lang.Object

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

Field Detail

RUN_PERIODIC_TASK_MSG_SUB_TYPE

public static final String RUN_PERIODIC_TASK_MSG_SUB_TYPE

See Also:

Constant Field Values

Constructor Detail

RunPeriodicTaskMessage

public RunPeriodicTaskMessage(String taskRequestId,
                              String periodicTaskName,
                              String tableNameWithType,
                              Map<String,String> taskProperties)

Parameters:

taskRequestId - Request Id that will be appended to log messages.

periodicTaskName - Name of the task that will be run.

tableNameWithType - Table (names with type suffix) on which task will run.

RunPeriodicTaskMessage

public RunPeriodicTaskMessage(org.apache.helix.model.Message message)

Method Detail

getPeriodicTaskRequestId

public String getPeriodicTaskRequestId()

getPeriodicTaskName

public String getPeriodicTaskName()

getTableNameWithType

public String getTableNameWithType()

getTaskProperties

public Map<String,String> getTaskProperties()