Package uk.gov.gchq.gaffer.federatedstore.operation

Class GetAllGraphIds

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.operation.GetAllGraphIds

All Implemented Interfaces:

Closeable, AutoCloseable, IFederationOperation, Output<Iterable<? extends String>>, Operation

public class GetAllGraphIds
extends Object
implements IFederationOperation, Output<Iterable<? extends String>>

An Operation to get all the graphIds within scope of the FederatedStore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetAllGraphIds.Builder

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
GetAllGraphIds()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends String>>	getOutputTypeReference()
boolean	isUserRequestingAdminUsage()
void	setOptions(Map<String,String> options)
GetAllGraphIds	setUserRequestingAdminUsage(boolean adminRequest)
GetAllGraphIds	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

GetAllGraphIds

public GetAllGraphIds()

Method Detail

getOutputTypeReference

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

Specified by:

getOutputTypeReference in interface Output<Iterable<? extends String>>

shallowClone

public GetAllGraphIds 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.

isUserRequestingAdminUsage

public boolean isUserRequestingAdminUsage()

Specified by:

isUserRequestingAdminUsage in interface IFederationOperation

setUserRequestingAdminUsage

public GetAllGraphIds setUserRequestingAdminUsage(boolean adminRequest)

Specified by:

setUserRequestingAdminUsage in interface IFederationOperation

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.