Package com.hazelcast.jet

Class JobStatusEvent

java.lang.Object

com.hazelcast.jet.JobStatusEvent

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable

public class JobStatusEvent
extends java.lang.Object
implements IdentifiedDataSerializable

Holds information about a job's state (status) transition, reason for the transition, and whether it is user-initiated.

Since:

5.3

See Also:

JobStatusListener

Constructor Summary

Constructors

Constructor	Description
JobStatusEvent()
JobStatusEvent(long jobId, JobStatus previousStatus, JobStatus newStatus, java.lang.String description, boolean userRequested)

Method Summary

Modifier and Type	Method	Description
int	getClassId()	Returns type identifier for this class.
java.lang.String	getDescription()	If the event is generated by the user, indicates the action; if there is a failure, indicates the cause; otherwise, null.
int	getFactoryId()	Returns DataSerializableFactory factory ID for this class.
long	getJobId()
JobStatus	getNewStatus()
JobStatus	getPreviousStatus()
boolean	isUserRequested()	Indicates whether the event is generated by the user via Job.suspend(), Job.resume(), Job.restart(), Job.cancel(), Job.exportSnapshot(String), or Job.cancelAndExportSnapshot(String).
void	readData(ObjectDataInput in)	Reads fields from the input stream
java.lang.String	toString()
void	writeData(ObjectDataOutput out)	Writes object fields to output stream

Methods inherited from class java.lang.Object

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

Constructor Detail

JobStatusEvent

public JobStatusEvent()

JobStatusEvent

public JobStatusEvent(long jobId,
                      @Nonnull
                      JobStatus previousStatus,
                      @Nonnull
                      JobStatus newStatus,
                      @Nullable
                      java.lang.String description,
                      boolean userRequested)

Method Detail

getJobId

public long getJobId()

getPreviousStatus

@Nonnull
public JobStatus getPreviousStatus()

getNewStatus

@Nonnull
public JobStatus getNewStatus()

getDescription

@Nullable
public java.lang.String getDescription()

If the event is generated by the user, indicates the action; if there is a failure, indicates the cause; otherwise, null.

isUserRequested

public boolean isUserRequested()

Indicates whether the event is generated by the user via Job.suspend(), Job.resume(), Job.restart(), Job.cancel(), Job.exportSnapshot(String), or Job.cancelAndExportSnapshot(String).

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws java.io.IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws java.io.IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object