Class FederatedOperation<INPUT,OUTPUT>
- java.lang.Object
-
- uk.gov.gchq.gaffer.federatedstore.operation.FederatedOperation<INPUT,OUTPUT>
-
- Type Parameters:
INPUT
- Input type of the payload operationOUTPUT
- Output type of the merge function
- All Implemented Interfaces:
Closeable
,AutoCloseable
,IFederatedOperation
,IFederationOperation
,Input<INPUT>
,InputOutput<INPUT,OUTPUT>
,Output<OUTPUT>
,Operation
,Operations<Operation>
@Deprecated public class FederatedOperation<INPUT,OUTPUT> extends Object implements IFederationOperation, IFederatedOperation, InputOutput<INPUT,OUTPUT>, Operations<Operation>
Deprecated.Concept of a FederatedOperation class will not exist from 2.4.0, all federation specifics are handled via operation options.This operation federates a payload operation across a given set of graphs and merges the results with a given function.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FederatedOperation.Builder
Deprecated.static class
FederatedOperation.BuilderParent<INPUT,OUTPUT>
Deprecated.-
Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.federatedstore.operation.IFederationOperation
IFederationOperation.BaseBuilder<OP extends IFederationOperation,B extends Operation.BaseBuilder<OP,?>>
-
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 FederatedOperation()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FederatedOperation<INPUT,OUTPUT>
deepClone()
Deprecated.boolean
equals(Object o)
Deprecated.List<String>
getGraphIds()
Deprecated.INPUT
getInput()
Deprecated.FederatedOperation does not have input.BiFunction
getMergeFunction()
Deprecated.Collection<Operation>
getOperations()
Deprecated.Should return aCollection
of all operations contained within theOperations
implementation.Map<String,String>
getOptions()
Deprecated.com.fasterxml.jackson.core.type.TypeReference
getOutputTypeReference()
Deprecated.Class<? extends Operation>
getPayloadClass()
Deprecated.Operation
getPayloadOperation()
Deprecated.Returns a shallow clone of the payload operation.Operation
getUnClonedPayload()
Deprecated.Use responsibly internals including options may incorrectly get modified.FederatedOperation<INPUT,OUTPUT>
graphIds(List<String> graphIds)
Deprecated.FederatedOperation<INPUT,OUTPUT>
graphIdsCSV(String graphIds)
Deprecated.int
hashCode()
Deprecated.boolean
hasPayloadOperation()
Deprecated.boolean
isSkipFailedFederatedExecution()
Deprecated.boolean
isUserRequestingAdminUsage()
Deprecated.FederatedOperation<INPUT,OUTPUT>
mergeFunction(BiFunction mergeFunction)
Deprecated.FederatedOperation<INPUT,OUTPUT>
options(Map<String,String> options)
Deprecated.boolean
payloadInstanceOf(Class<?> c)
Deprecated.FederatedOperation<INPUT,OUTPUT>
payloadOperation(Operation op)
Deprecated.void
setInput(INPUT input)
Deprecated.FederatedOperation does not have input, but will pass through to payload.void
setOptions(Map<String,String> options)
Deprecated.FederatedOperation<INPUT,OUTPUT>
setUserRequestingAdminUsage(boolean adminRequest)
Deprecated.FederatedOperation<INPUT,OUTPUT>
shallowClone()
Deprecated.Operation implementations should ensure a ShallowClone method is implemented.FederatedOperation<INPUT,OUTPUT>
skipFailedFederatedExecution(boolean skipFailedFederatedExecution)
Deprecated.-
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation
_getNullOrOptions, addOption, containsOption, getOption, getOption, validate, validateRequiredFieldPresent
-
Methods inherited from interface uk.gov.gchq.gaffer.operation.Operations
flatten, getOperationsClass, updateOperations
-
Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output
castToOutputType, getOutputClass, getOutputType
-
-
-
-
Method Detail
-
graphIds
public FederatedOperation<INPUT,OUTPUT> graphIds(List<String> graphIds)
Deprecated.- Specified by:
graphIds
in interfaceIFederatedOperation
-
graphIdsCSV
public FederatedOperation<INPUT,OUTPUT> graphIdsCSV(String graphIds)
Deprecated.- Specified by:
graphIdsCSV
in interfaceIFederatedOperation
-
payloadOperation
public FederatedOperation<INPUT,OUTPUT> payloadOperation(Operation op)
Deprecated.
-
getOperations
public Collection<Operation> getOperations()
Deprecated.Description copied from interface:Operations
Should return aCollection
of all operations contained within theOperations
implementation. The collection of operations may be modified by Gaffer.- Specified by:
getOperations
in interfaceOperations<INPUT>
- Returns:
- A
Collection
ofOperation
s.
-
mergeFunction
public FederatedOperation<INPUT,OUTPUT> mergeFunction(BiFunction mergeFunction)
Deprecated.
-
isSkipFailedFederatedExecution
public boolean isSkipFailedFederatedExecution()
Deprecated.
-
isUserRequestingAdminUsage
public boolean isUserRequestingAdminUsage()
Deprecated.- Specified by:
isUserRequestingAdminUsage
in interfaceIFederationOperation
-
setUserRequestingAdminUsage
public FederatedOperation<INPUT,OUTPUT> setUserRequestingAdminUsage(boolean adminRequest)
Deprecated.- Specified by:
setUserRequestingAdminUsage
in interfaceIFederationOperation
-
skipFailedFederatedExecution
public FederatedOperation<INPUT,OUTPUT> skipFailedFederatedExecution(boolean skipFailedFederatedExecution)
Deprecated.
-
setOptions
public void setOptions(Map<String,String> options)
Deprecated.- Specified by:
setOptions
in interfaceOperation
- 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.
-
getGraphIds
public List<String> getGraphIds()
Deprecated.- Specified by:
getGraphIds
in interfaceIFederatedOperation
-
getPayloadOperation
public Operation getPayloadOperation()
Deprecated.Returns a shallow clone of the payload operation.- Returns:
- cloned payload
-
hasPayloadOperation
public boolean hasPayloadOperation()
Deprecated.
-
getUnClonedPayload
public Operation getUnClonedPayload()
Deprecated.Use responsibly internals including options may incorrectly get modified.- Returns:
- uncloned payload
-
payloadInstanceOf
public boolean payloadInstanceOf(Class<?> c)
Deprecated.
-
getMergeFunction
public BiFunction getMergeFunction()
Deprecated.
-
getOptions
public Map<String,String> getOptions()
Deprecated.- Specified by:
getOptions
in interfaceOperation
- 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.
-
shallowClone
public FederatedOperation<INPUT,OUTPUT> shallowClone() throws org.apache.commons.lang3.exception.CloneFailedException
Deprecated.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 interfaceOperation
- Returns:
- shallow clone
- Throws:
org.apache.commons.lang3.exception.CloneFailedException
- if a Clone error occurs
-
deepClone
public FederatedOperation<INPUT,OUTPUT> deepClone() throws org.apache.commons.lang3.exception.CloneFailedException
Deprecated.- Throws:
org.apache.commons.lang3.exception.CloneFailedException
-
getOutputTypeReference
public com.fasterxml.jackson.core.type.TypeReference getOutputTypeReference()
Deprecated.- Specified by:
getOutputTypeReference
in interfaceOutput<INPUT>
-
getInput
public INPUT getInput()
Deprecated.FederatedOperation does not have input.
-
-