Package uk.gov.gchq.gaffer.store.operation

Class GetSchema

java.lang.Object

uk.gov.gchq.gaffer.store.operation.GetSchema

All Implemented Interfaces:

Closeable, AutoCloseable, Output<Schema>, Operation

public class GetSchema
extends Object
implements Output<Schema>

A GetSchema is an Operation which returns either the compact or full Schema for a Gaffer Store.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Schema>	getOutputTypeReference()
boolean	isCompact()
void	setCompact(boolean compact)
void	setOptions(Map<String,String> options)
GetSchema	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

GetSchema

public GetSchema()

Method Detail

isCompact

public boolean isCompact()

setCompact

public void setCompact(boolean compact)

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 GetSchema 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<Schema> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<Schema>