Package uk.gov.gchq.gaffer.operation.impl.job

Class CancelScheduledJob

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.job.CancelScheduledJob

All Implemented Interfaces:

Closeable, AutoCloseable, Operation

public class CancelScheduledJob
extends Object
implements Operation

A CancelScheduledJob is an Operation that will use the provided jobId to cancel the job, if it is scheduled.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CancelScheduledJob.Builder

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation

Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>

Constructor Summary

Constructors

Constructor	Description
CancelScheduledJob()

Method Summary

Modifier and Type	Method	Description
String	getJobId()
Map<String,String>	getOptions()
void	setJobId(String jobId)
void	setOptions(Map<String,String> options)
CancelScheduledJob	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation

_getNullOrOptions, addOption, close, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

Constructor Detail

CancelScheduledJob

public CancelScheduledJob()

Method Detail

getJobId

public String getJobId()

setJobId

public void setJobId(String jobId)

shallowClone

public CancelScheduledJob shallowClone()
                                throws org.apache.commons.lang3.exception.CloneFailedException

Description copied from interface: Operation

Operation implementations should ensure a ShallowClone method is implemented. Performs a shallow clone. Creates a new instance and copies the fields across. It does not clone the fields. If the operation contains nested operations, these must also be cloned.

Specified by:

shallowClone in interface Operation

Returns:

shallow clone

Throws:

org.apache.commons.lang3.exception.CloneFailedException - if a Clone error occurs

getOptions

public Map<String,String> getOptions()

Specified by:

getOptions in interface Operation

Returns:

the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

setOptions

public void setOptions(Map<String,String> options)

Specified by:

setOptions in interface Operation

Parameters:

options - the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.