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

Class AddElementsFromSocket

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.add.AddElementsFromSocket

All Implemented Interfaces:

Closeable, AutoCloseable, Operation, Validatable

public class AddElementsFromSocket
extends Object
implements Operation, Validatable

An AddElementsFromSocket operation consumes records from a socket, converts each record into a Gaffer Element using the provided ElementGenerator then adds these elements to the Graph. This operation uses Flink so you can either run it in local mode or configure Flink on your cluster to distribute the job. This operation is a blocking operation and will only stop when the socket is closed or you manually terminate the job.

See Also:

AddElementsFromSocket.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddElementsFromSocket.Builder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DELIMITER

Constructor Summary

Constructors

Constructor	Description
AddElementsFromSocket()

Method Summary

Modifier and Type	Method	Description
String	getDelimiter()
Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>>	getElementGenerator()
String	getHostname()
Map<String,String>	getOptions()
Integer	getParallelism()
int	getPort()
boolean	isSkipInvalidElements()
boolean	isValidate()
void	setDelimiter(String delimiter)
void	setElementGenerator(Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>> elementGenerator)
void	setHostname(String hostname)
void	setOptions(Map<String,String> options)
void	setParallelism(Integer parallelism)
void	setPort(int port)
void	setSkipInvalidElements(boolean skipInvalidElements)
void	setValidate(boolean validate)
AddElementsFromSocket	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

Field Detail

DEFAULT_DELIMITER

public static final String DEFAULT_DELIMITER

See Also:

Constant Field Values

Constructor Detail

AddElementsFromSocket

public AddElementsFromSocket()

Method Detail

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

getPort

public int getPort()

setPort

public void setPort(int port)

getElementGenerator

public Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>> getElementGenerator()

setElementGenerator

public void setElementGenerator(Class<? extends Function<Iterable<? extends String>,Iterable<? extends Element>>> elementGenerator)

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.

isSkipInvalidElements

public boolean isSkipInvalidElements()

Specified by:

isSkipInvalidElements in interface Validatable

Returns:

true if invalid elements should be skipped. Otherwise false if the operation should fail.

setSkipInvalidElements

public void setSkipInvalidElements(boolean skipInvalidElements)

Specified by:

setSkipInvalidElements in interface Validatable

Parameters:

skipInvalidElements - true if invalid elements should be skipped. Otherwise false if the operation should fail.

isValidate

public boolean isValidate()

Specified by:

isValidate in interface Validatable

Returns:

true if the operation should be validated. Otherwise false.

setValidate

public void setValidate(boolean validate)

Specified by:

setValidate in interface Validatable

Parameters:

validate - true if the operation should be validated. Otherwise false.

getDelimiter

public String getDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

setParallelism

public void setParallelism(Integer parallelism)

getParallelism

public Integer getParallelism()

shallowClone

public AddElementsFromSocket shallowClone()

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