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

Class GetAllGraphInfo

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.operation.GetAllGraphInfo

All Implemented Interfaces:

Closeable, AutoCloseable, IFederatedOperation, IFederationOperation, Output<Map<String,Object>>, Operation

public class GetAllGraphInfo
extends Object
implements Output<Map<String,Object>>, IFederationOperation, IFederatedOperation

Gets graph info of selected Graphs from the FederatedStore.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<String>	getGraphIds()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Map<String,Object>>	getOutputTypeReference()
GetAllGraphInfo	graphIds(List<String> graphsIds)
GetAllGraphInfo	graphIdsCSV(String graphIds)
int	hashCode()
boolean	isUserRequestingAdminUsage()
void	setOptions(Map<String,String> options)
GetAllGraphInfo	setUserRequestingAdminUsage(boolean adminRequest)
GetAllGraphInfo	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.

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, close, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

GetAllGraphInfo

public GetAllGraphInfo()

Method Detail

graphIds

public GetAllGraphInfo graphIds(List<String> graphsIds)

Specified by:

graphIds in interface IFederatedOperation

graphIdsCSV

public GetAllGraphInfo graphIdsCSV(String graphIds)

Specified by:

graphIdsCSV in interface IFederatedOperation

getGraphIds

public List<String> getGraphIds()

Specified by:

getGraphIds in interface IFederatedOperation

getOutputTypeReference

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

Specified by:

getOutputTypeReference in interface Output<Map<String,Object>>

shallowClone

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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 GetAllGraphInfo 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.