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

Class GetFromEndpoint

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.get.GetFromEndpoint

All Implemented Interfaces:

Closeable, AutoCloseable, Output<String>, Operation

public class GetFromEndpoint
extends Object
implements Output<String>, Operation

A GetFromEndpoint is an Operation that will fetch data from a provided endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetFromEndpoint.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
GetFromEndpoint()

Method Summary

Modifier and Type	Method	Description
String	getEndpoint()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<String>	getOutputTypeReference()
void	setEndpoint(String endpoint)
void	setOptions(Map<String,String> options)
GetFromEndpoint	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

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output

castToOutputType, getOutputClass, getOutputType

Constructor Detail

GetFromEndpoint

public GetFromEndpoint()

Method Detail

getEndpoint

public String getEndpoint()

setEndpoint

public void setEndpoint(String endpoint)

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.

shallowClone

public GetFromEndpoint 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

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<String> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<String>