gafferpy.generated_api package

Submodules

gafferpy.generated_api.binary_operators module

gafferpy.generated_api.config module

This module has been generated with fishbowl. To make changes, either extend these classes or change fishbowl.

class gafferpy.generated_api.config.GetAggregationFunctions: Bases: GetGraph

class gafferpy.generated_api.config.GetDescription: Bases: GetGraph

class gafferpy.generated_api.config.GetElementGenerators: Bases: GetGraph

class gafferpy.generated_api.config.GetFilterFunctions(input_class=''): Bases: GetGraph

class gafferpy.generated_api.config.GetId: Bases: GetGraph

class gafferpy.generated_api.config.GetJobs(id=''): Bases: GetGraph

class gafferpy.generated_api.config.GetJobsResults(id=''): Bases: GetGraph

class gafferpy.generated_api.config.GetObjectGenerators: Bases: GetGraph

class gafferpy.generated_api.config.GetOperations(class_name=''): Bases: GetGraph

class gafferpy.generated_api.config.GetOperationsAll: Bases: GetGraph

class gafferpy.generated_api.config.GetOperationsDetails: Bases: GetGraph

class gafferpy.generated_api.config.GetOperationsDetailsAll: Bases: GetGraph

class gafferpy.generated_api.config.GetOperationsExample(class_name=''): Bases: GetGraph

class gafferpy.generated_api.config.GetOperationsNext(class_name=''): Bases: GetGraph

class gafferpy.generated_api.config.GetSchema: Bases: GetGraph

class gafferpy.generated_api.config.GetSerialisedFields(class_name=''): Bases: GetGraph

class gafferpy.generated_api.config.GetSerialisedFieldsClasses(class_name=''): Bases: GetGraph

class gafferpy.generated_api.config.GetStatus: Bases: GetGraph

class gafferpy.generated_api.config.GetStoreTraits: Bases: GetGraph

class gafferpy.generated_api.config.GetStoreType: Bases: GetGraph

class gafferpy.generated_api.config.GetTransformFunctions: Bases: GetGraph

class gafferpy.generated_api.config.GetVersion: Bases: GetGraph

gafferpy.generated_api.functions module

This module has been generated with fishbowl. To make changes, either extend these classes or change fishbowl.

class gafferpy.generated_api.functions.AggregatorUtilToElementKey

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.store.util.AggregatorUtil$ToElementKey'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.AggregatorUtilToIngestElementKey

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.store.util.AggregatorUtil$ToIngestElementKey'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.AggregatorUtilToQueryElementKey

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.store.util.AggregatorUtil$ToQueryElementKey'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ApplyBiFunction(function: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ApplyBiFunction'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Base64Decode

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Base64Decode'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.CallMethod(method: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.CallMethod'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Cast(output_class: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Cast'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Concat(separator: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Concat'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.CreateObject(object_class: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.CreateObject'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.CsvGenerator(quoted: bool | None = None, comma_replacement: str | None = None, include_default_fields: bool | None = None, include_schema_properties: bool | None = None, constants: Dict[str, str] | None = None, fields: Dict[str, str] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.CsvGenerator'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.CsvLinesToMaps'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.CsvToMaps'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.CurrentDate

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.CurrentDate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.CurrentTime

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.CurrentTime'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DateToTimeBucketEnd(bucket: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.DateToTimeBucketEnd'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DateToTimeBucketStart(bucket: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.DateToTimeBucketStart'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DefaultIfEmpty(default_value: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.DefaultIfEmpty'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DefaultIfNull(default_value: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.DefaultIfNull'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DeserialiseJson(output_class: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.DeserialiseJson'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DeserialiseXml

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.DeserialiseXml'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DictionaryLookup(dictionary: Dict[Any, Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.DictionaryLookup'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Divide

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Divide'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.DivideBy(by: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.DivideBy'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.EdgeIdExtractor

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.data.generator.EdgeIdExtractor'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ElementTransformer(functions: List[Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ElementTransformer'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.EntityIdExtractor(edge_identifier_to_extract: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.data.generator.EntityIdExtractor'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExampleDomainObjectGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.rest.example.ExampleDomainObjectGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExampleElementGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.rest.example.ExampleElementGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExampleTransformFunction

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.rest.example.ExampleTransformFunction'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractGroup

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ExtractGroup'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractId(id: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ExtractId'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractKeys

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ExtractKeys'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractProperty(name: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ExtractProperty'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractValue(key: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ExtractValue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractValues

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ExtractValues'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractWalkEdges

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.graph.function.walk.ExtractWalkEdges'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractWalkEdgesFromHop(hop: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.graph.function.walk.ExtractWalkEdgesFromHop'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractWalkEntities

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.graph.function.walk.ExtractWalkEntities'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractWalkEntitiesFromHop(hop: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.graph.function.walk.ExtractWalkEntitiesFromHop'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ExtractWalkVertex

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.graph.function.walk.ExtractWalkVertex'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FirstItem

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.FirstItem'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FirstValid(predicate: Predicate | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.FirstValid'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FreqMapExtractor(key: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.FreqMapExtractor'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FreqMapPredicator(predicate: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.FreqMapPredicator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FromElementId

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.function.FromElementId'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FromEntityId

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.function.FromEntityId'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FunctionChain(functions: List[Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.FunctionChain'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FunctionComposite(functions: List[Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.function.FunctionComposite'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.FunctionMap(function: Function | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.function.FunctionMap'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.GafferEdgeGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.tinkerpop.generator.GafferEdgeGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.GafferEntityGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.tinkerpop.generator.GafferEntityGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.GafferPopEdgeGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.tinkerpop.generator.GafferPopEdgeGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.GafferPopElementGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.tinkerpop.generator.GafferPopElementGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.GafferPopVertexGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.tinkerpop.generator.GafferPopVertexGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Gunzip

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Gunzip'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.HllSketchEntityGenerator(properties_to_copy: List[str] | None = None, count_property: str | None = None, cardinality_property_name: str | None = None, edge_group_property: str | None = None, vertex_value_converter: Function | None = None, group: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.sketches.datasketches.cardinality.HllSketchEntityGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.HyperLogLogPlusEntityGenerator(properties_to_copy: List[str] | None = None, count_property: str | None = None, cardinality_property_name: str | None = None, edge_group_property: str | None = None, vertex_value_converter: Function | None = None, group: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.sketches.clearspring.cardinality.HyperLogLogPlusEntityGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Identity

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Identity'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.If(otherwise: Function | None = None, predicate: Predicate | None = None, condition: bool | None = None, then: Function | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.If'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Increment(increment: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Increment'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IsEmpty

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.IsEmpty'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableConcat

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.IterableConcat'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableFilter(predicate: Predicate | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.IterableFilter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableFlatten(operator: BinaryOperator | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.IterableFlatten'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableFunction(functions: List[Function] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.IterableFunction'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableLongest

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.IterableLongest'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableToFreqMap

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.IterableToFreqMap'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableToHllSketch(log_k: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.sketches.datasketches.cardinality.function.IterableToHllSketch'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.IterableToHyperLogLogPlus(p: int | None = None, sp: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.sketches.clearspring.cardinality.function.IterableToHyperLogLogPlus'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.JsonToElementGenerator

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.JsonToElementGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.LastItem

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.LastItem'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Length(max_length: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Length'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Longest

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Longest'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.MapFilter(key_predicate: Predicate | None = None, key_value_predicate: Any | None = None, value_predicate: Predicate | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.MapFilter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.MapGenerator(constants: Dict[str, str] | None = None, fields: Dict[str, str] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.MapGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.MapToTuple

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.MapToTuple'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.MaskTimestampSetByTimeRange(start_time: int | None = None, end_time: int | None = None, time_unit: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.MaskTimestampSetByTimeRange'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Multiply

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Multiply'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.MultiplyBy(by: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.MultiplyBy'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.MultiplyLongBy(by: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.MultiplyLongBy'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Neo4jCsvElementGenerator(first_row: int | None = None, trim: bool | None = None, delimiter: str | None = None, null_string: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.Neo4jCsvElementGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Neo4jCsvGenerator(quoted: bool | None = None, comma_replacement: str | None = None, include_default_fields: bool | None = None, include_schema_properties: bool | None = None, constants: Dict[str, str] | None = None, fields: Dict[str, str] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.Neo4jCsvGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.NeptuneCsvElementGenerator(first_row: int | None = None, trim: bool | None = None, delimiter: str | None = None, null_string: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.NeptuneCsvElementGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.NeptuneCsvGenerator(quoted: bool | None = None, comma_replacement: str | None = None, include_default_fields: bool | None = None, include_schema_properties: bool | None = None, constants: Dict[str, str] | None = None, fields: Dict[str, str] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.generator.NeptuneCsvGenerator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.NthItem(selection: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.NthItem'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ParseDate(format: str | None = None, time_zone: str | None = None, microseconds: bool | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ParseDate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ParseTime(format: str | None = None, time_zone: str | None = None, time_unit: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ParseTime'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.PropertiesTransformer(functions: List[Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.PropertiesTransformer'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ReduceRelatedElements(visibility_aggregator: BinaryOperator | None = None, vertex_aggregator: BinaryOperator | None = None, related_vertex_groups: Set[str] | None = None, visibility_property: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ReduceRelatedElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ReverseString

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ReverseString'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.SetValue(value: Any | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.SetValue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.Size

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.Size'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringAppend(suffix: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringAppend'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringJoin(delimiter: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringJoin'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringPrepend(prefix: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringPrepend'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringRegexReplace(regex: str | None = None, replacement: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringRegexReplace'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringRegexSplit(regex: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringRegexSplit'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringReplace(search_string: str | None = None, replacement: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringReplace'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringSplit(delimiter: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringSplit'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringTrim

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringTrim'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringTruncate(length: int | None = None, ellipses: bool | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.StringTruncate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringsToTypeSubTypeValue

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.StringsToTypeSubTypeValue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.StringsToTypeValue

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.StringsToTypeValue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToArray

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToArray'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToBoolean

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToBoolean'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToBytes(charset: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToBytes'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToDateString(format: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToDateString'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToDouble

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToDouble'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToElementId

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.function.ToElementId'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToElementTuple

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ToElementTuple'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToEntityId

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.function.ToEntityId'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToFloat

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToFloat'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToFreqMap

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.ToFreqMap'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToHllSketch(log_k: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.sketches.datasketches.cardinality.function.ToHllSketch'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToHyperLogLogPlus(p: int | None = None, sp: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.sketches.clearspring.cardinality.function.ToHyperLogLogPlus'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToInteger

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToInteger'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToList

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToList'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToLong

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToLong'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToLowerCase

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToLowerCase'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToNull

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToNull'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToPropertiesTuple

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ToPropertiesTuple'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToSet(implementation: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToSet'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToSingletonTreeSet

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.ToSingletonTreeSet'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToString(charset: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToString'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTimeBucket(bucket: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.ToTimeBucket'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTimeBucketEnd(bucket: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.ToTimeBucketEnd'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTimeBucketStart(bucket: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.ToTimeBucketStart'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTimestampSet(bucket: str | None = None, max_size: int | None = None, millis_correction: int | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.time.function.ToTimestampSet'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTrailingWildcardPair(end_of_range: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.operation.function.ToTrailingWildcardPair'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTuple

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToTuple'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTypeSubTypeValue(sub_type: str | None = None, type: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.ToTypeSubTypeValue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToTypeValue(type: str | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.types.function.ToTypeValue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.ToUpperCase

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.impl.function.ToUpperCase'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.tuple.function.TupleAdaptedFunction'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.TupleAdaptedFunctionComposite(functions: List[Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.tuple.function.TupleAdaptedFunctionComposite'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.TupleInputAdapter(selection: List[Any] | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.koryphe.tuple.TupleInputAdapter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.TupleToElements(elements: List[Any] | None = None, use_group_mapping: bool | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.TupleToElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.TuplesToElements(elements: List[Any] | None = None, use_group_mapping: bool | None = None)

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.TuplesToElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.TypeSubTypeValueToTuple

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.TypeSubTypeValueToTuple'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.TypeValueToTuple

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.TypeValueToTuple'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.functions.UnwrapEntityId

Bases: AbstractFunction

CLASS = 'uk.gov.gchq.gaffer.data.element.function.UnwrapEntityId'

to_json(): Converts an object to a simple json dictionary

gafferpy.generated_api.operations module

This module has been generated with fishbowl. To make changes, either extend these classes or change fishbowl.

class gafferpy.generated_api.operations.AddElements(input: List[Element] | None = None, skip_invalid_elements: bool | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds elements

Parameters:

input –
skip_invalid_elements –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.add.AddElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddElementsFromFile(element_generator: Any, filename: str, parallelism: int | None = None, skip_invalid_elements: bool | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds elements from a file

Parameters:

element_generator –
filename –
parallelism –
skip_invalid_elements –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.add.AddElementsFromFile'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddElementsFromHdfs(job_initialiser: Any, input_mapper_pairs: Dict[str, str], failure_path: str, output_path: str, splits_file_path: str | None = None, num_map_tasks: int | None = None, working_path: str | None = None, min_reduce_tasks: int | None = None, max_reduce_tasks: int | None = None, min_map_tasks: int | None = None, use_provided_splits: bool | None = None, command_line_args: List[str] | None = None, partitioner: Any | None = None, max_map_tasks: int | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds elements from hdfs

Parameters:

job_initialiser –
input_mapper_pairs –
failure_path –
output_path –
splits_file_path –
num_map_tasks –
working_path –
min_reduce_tasks –
max_reduce_tasks –
min_map_tasks –
use_provided_splits –
command_line_args –
partitioner –
max_map_tasks –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.hdfs.operation.AddElementsFromHdfs'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddElementsFromKafka(element_generator: Any, bootstrap_servers: List[str], group_id: str, topic: str, parallelism: int | None = None, consume_as: Any | None = None, skip_invalid_elements: bool | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds elements from Kafka

Parameters:

element_generator –
bootstrap_servers –
group_id –
topic –
parallelism –
consume_as –
skip_invalid_elements –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.add.AddElementsFromKafka'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddElementsFromSocket(element_generator: Any, hostname: str, port: int, delimiter: str | None = None, parallelism: int | None = None, skip_invalid_elements: bool | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds elements from a socket

Parameters:

element_generator –
hostname –
port –
delimiter –
parallelism –
skip_invalid_elements –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.add.AddElementsFromSocket'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddGraph(graph_id: str, schema: Dict | None = None, write_access_predicate: Any | None = None, store_properties: Dict | None = None, parent_properties_id: str | None = None, read_access_predicate: Any | None = None, graph_auths: Set[str] | None = None, is_public: bool | None = None, parent_schema_ids: List[str] | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds a new Graph to the federated store

Parameters:

graph_id –
schema –
write_access_predicate –
store_properties –
parent_properties_id –
read_access_predicate –
graph_auths –
is_public –
parent_schema_ids –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.AddGraph'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Adds a new Graph with hooks to the federated store

Parameters:

schema –
write_access_predicate –
store_properties –
parent_properties_id –
read_access_predicate –
graph_auths –
is_public –
parent_schema_ids –
graph_id –
hooks –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.AddGraphWithHooks'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Adds a new named operation

Parameters:

overwrite_flag –
write_access_predicate –
score –
read_access_roles –
read_access_predicate –
description –
operation_name –
operation_chain –
parameters –
write_access_roles –
labels –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.named.operation.AddNamedOperation'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddNamedView(view: Any, name: str, overwrite_flag: bool | None = None, write_access_predicate: Any | None = None, read_access_predicate: Any | None = None, description: str | None = None, parameters: Dict[str, Any] | None = None, write_access_roles: List[str] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds a new named view

Parameters:

view –
name –
overwrite_flag –
write_access_predicate –
read_access_predicate –
description –
parameters –
write_access_roles –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.named.view.AddNamedView'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddSchemaToLibrary(schema: Dict, id: str, parent_schema_ids: List[str] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds a Schema to the GraphLibrary

Parameters:

schema –
id –
parent_schema_ids –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.store.operation.add.AddSchemaToLibrary'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.AddStorePropertiesToLibrary(store_properties: Dict, id: str, parent_properties_id: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Adds StoreProperties to the GraphLibrary

Parameters:

store_properties –
id –
parent_properties_id –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.store.operation.add.AddStorePropertiesToLibrary'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Aggregate(input: List[Element] | None = None, entities: Dict[str, AggregatePair] | None = None, edges: Dict[str, AggregatePair] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Aggregates elements

Parameters:

input –
entities –
edges –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.function.Aggregate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.CancelScheduledJob(job_id: str, options: Dict[str, str] | None = None)

Bases: Operation

Cancels a scheduled job

Parameters:

job_id –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.job.CancelScheduledJob'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ChangeGraphAccess(graph_id: str, owner_user_id: str | None = None, graph_auths: Set[str] | None = None, is_public: bool | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Changes the protection used for accessing graphs

Parameters:

graph_id –
owner_user_id –
graph_auths –
is_public –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Boolean

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.ChangeGraphAccess'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ChangeGraphId(graph_id: str, new_graph_id: str | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Changes the Id of a graph

Parameters:

graph_id –
new_graph_id –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Boolean

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.ChangeGraphId'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Count(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Counts the number of items

Parameters:

input –
options – Additional map of options

Returns:

java.lang.Long

CLASS = 'uk.gov.gchq.gaffer.operation.impl.Count'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.CountAllElementsDefaultView(input: List[Element] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Counts all elements

Parameters:

input –
options – Additional map of options

Returns:

java.lang.Long

CLASS = 'uk.gov.gchq.gaffer.mapstore.operation.CountAllElementsDefaultView'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.CountGroups(input: List[Element] | None = None, limit: int | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Counts the different element groups

Parameters:

input –
limit –
options – Additional map of options

Returns:

uk.gov.gchq.gaffer.data.GroupCounts

CLASS = 'uk.gov.gchq.gaffer.operation.impl.CountGroups'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.DeleteAllData(options: Dict[str, str] | None = None)

Bases: Operation

This operation is used to self delete all retained data

Parameters:: options – Additional map of options
Returns:: java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.store.operation.DeleteAllData'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.DeleteElements(input: List[Element] | None = None, skip_invalid_elements: bool | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Deletes elements

Parameters:

input –
skip_invalid_elements –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.delete.DeleteElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.DeleteNamedOperation(operation_name: str, options: Dict[str, str] | None = None)

Bases: Operation

Deletes a named operation

Parameters:

operation_name –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.named.operation.DeleteNamedOperation'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.DeleteNamedView(name: str, options: Dict[str, str] | None = None)

Bases: Operation

Deletes a named view

Parameters:

name –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.named.view.DeleteNamedView'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.DiscardOutput(input: Any | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Discards the results from the previous operation

Parameters:

input –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.DiscardOutput'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ExportToGafferResultCache(input: Any | None = None, op_auths: Set[str] | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Exports to a cache backed by a Gaffer graph

Parameters:

input –
op_auths –
key –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.resultcache.ExportToGafferResultCache'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ExportToLocalFile(file_path: str, input: List[str] | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Exports elements to a local file

Parameters:

file_path –
input –
key –
options – Additional map of options

Returns:

java.lang.Iterable<java.lang.String>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.localfile.ExportToLocalFile'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ExportToOtherAuthorisedGraph(graph_id: str, input: List[Element] | None = None, parent_store_properties_id: str | None = None, parent_schema_ids: List[str] | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Exports elements to another authorised Graph

Parameters:

graph_id –
input –
parent_store_properties_id –
parent_schema_ids –
key –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.export.graph.ExportToOtherAuthorisedGraph'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ExportToOtherGraph(graph_id: str, schema: Dict | None = None, input: List[Element] | None = None, parent_store_properties_id: str | None = None, store_properties: Dict | None = None, parent_schema_ids: List[str] | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Exports elements to another Graph

Parameters:

graph_id –
schema –
input –
parent_store_properties_id –
store_properties –
parent_schema_ids –
key –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.export.graph.ExportToOtherGraph'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ExportToSet(input: Any | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Exports results to a Set

Parameters:

input –
key –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.set.ExportToSet'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.FederatedOperation(skip_failed_federated_execution: Any | None = None, input: Any | None = None, graph_ids: List[str] | None = None, operation: Operation | None = None, merge_function: Any | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Federates a payload operation across given graphs and merges the results with a given function.

Parameters:

skip_failed_federated_execution –
input –
graph_ids –
operation –
merge_function –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.FederatedOperation'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Filter(input: List[Element] | None = None, global_edges: ElementFilter | None = None, global_entities: ElementFilter | None = None, entities: Dict[str, ElementFilter] | None = None, edges: Dict[str, ElementFilter] | None = None, global_elements: ElementFilter | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Filters elements

Parameters:

input –
global_edges –
global_entities –
entities –
edges –
global_elements –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.function.Filter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ForEach(input: List[Any] | None = None, operation: Operation | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Runs supplied operation on Iterable of inputs

Parameters:

input –
operation –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.ForEach'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GenerateElements(element_generator: Function, input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Generates elements from objects using provided generators

Parameters:

element_generator –
input –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.generate.GenerateElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GenerateObjects(element_generator: Function, input: List[Element] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Generates objects from elements using provided generators

Parameters:

element_generator –
input –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.generate.GenerateObjects'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GenerateSplitPointsFromSample(input: List[Any] | None = None, num_splits: int | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Generates split points from the supplied Iterable

Parameters:

input –
num_splits –
options – Additional map of options

Returns:

java.util.List<T>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.GenerateSplitPointsFromSample'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Performs a single hop down related edges

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.id.EntityId>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.get.GetAdjacentIds'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetAllElements(view: View | None = None, directed_type: str | None = None, views: List[View] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets all elements compatible with a provided View

Parameters:

view –
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.get.GetAllElements'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetAllGraphIds(user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets the ids of all available Graphs from a federated store

Parameters:

user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Iterable<java.lang.String>

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.GetAllGraphIds'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetAllGraphInfo(graph_ids: List[str] | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets graph info of selected Graphs from the FederatedStore

Parameters:

graph_ids –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.util.Map<java.lang.String,java.lang.Object>

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.GetAllGraphInfo'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetAllJobDetails(options: Dict[str, str] | None = None)

Bases: Operation

Gets all running and historic job details

Parameters:: options – Additional map of options
Returns:: java.lang.Iterable<uk.gov.gchq.gaffer.jobtracker.JobDetail>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.job.GetAllJobDetails'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetAllNamedOperations(options: Dict[str, str] | None = None)

Bases: Operation

Gets all available named operations

Parameters:: options – Additional map of options
Returns:: java.lang.Iterable<uk.gov.gchq.gaffer.named.operation.NamedOperationDetail>

CLASS = 'uk.gov.gchq.gaffer.named.operation.GetAllNamedOperations'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetAllNamedViews(options: Dict[str, str] | None = None)

Bases: Operation

Gets all available named views

Parameters:: options – Additional map of options
Returns:: java.lang.Iterable<uk.gov.gchq.gaffer.data.elementdefinition.view.NamedViewDetail>

CLASS = 'uk.gov.gchq.gaffer.named.view.GetAllNamedViews'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Gets elements related to provided seeds

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.get.GetElements'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Gets edges that exist between 2 sets and entities in the first set

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
input_b –
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.accumulostore.operation.impl.GetElementsBetweenSets'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Gets edges that exist between 2 sets and entities in the first set

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.accumulostore.operation.impl.GetElementsBetweenSetsPairs'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetElementsInRanges(input: List[Tuple[ElementSeed, ElementSeed]] | None = None, view: View | None = None, include_incoming_out_going: str | None = None, directed_type: str | None = None, views: List[View] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets elements that have vertices within a given range

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.accumulostore.operation.impl.GetElementsInRanges'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Gets edges with both vertices in a given set and entities with vertices in a given set

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.accumulostore.operation.impl.GetElementsWithinSet'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetExports(get_exports: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Fetches multiple exports

Parameters:

get_exports –
options – Additional map of options

Returns:

java.util.Map<java.lang.String,java.util.Set<java.lang.Object>>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.GetExports'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetFromEndpoint(endpoint: str, options: Dict[str, str] | None = None)

Bases: Operation

Gets data from an endpoint

Parameters:

endpoint –
options – Additional map of options

Returns:

java.lang.String

CLASS = 'uk.gov.gchq.gaffer.operation.impl.get.GetFromEndpoint'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetGafferResultCacheExport(job_id: str | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Fetches data from a Gaffer result cache

Parameters:

job_id –
key –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.resultcache.GetGafferResultCacheExport'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetGraphCreatedTime(options: Dict[str, str] | None = None)

Bases: Operation

Operation to retrieve Graph created date

Parameters:: options – Additional map of options
Returns:: java.util.Map<java.lang.String,java.lang.String>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.get.GetGraphCreatedTime'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetJobDetails(job_id: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets the details of a single job

Parameters:

job_id –
options – Additional map of options

Returns:

uk.gov.gchq.gaffer.jobtracker.JobDetail

CLASS = 'uk.gov.gchq.gaffer.operation.impl.job.GetJobDetails'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetJobResults(job_id: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets the results of a job

Parameters:

job_id –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.job.GetJobResults'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetProxyProperties(options: Dict[str, str] | None = None)

Bases: Operation

Gets ONLY the Proxy Properties value from the Proxy store

Parameters:: options – Additional map of options
Returns:: java.util.Map<java.lang.String,java.lang.Object>

CLASS = 'uk.gov.gchq.gaffer.proxystore.operation.GetProxyProperties'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetProxyUrl(options: Dict[str, str] | None = None)

Bases: Operation

Gets the Proxy URL value from the store properties

Parameters:: options – Additional map of options
Returns:: java.lang.String

CLASS = 'uk.gov.gchq.gaffer.proxystore.operation.GetProxyUrl'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetSchema(compact: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets the Schema of a Graph

Parameters:

compact –
options – Additional map of options

Returns:

uk.gov.gchq.gaffer.store.schema.Schema

CLASS = 'uk.gov.gchq.gaffer.store.operation.GetSchema'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Fetches data from a Set cache

Parameters:

job_id –
start –
end –
key –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.set.GetSetExport'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetTraits(current_traits: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

An Operation used for getting traits from the Store

Parameters:

current_traits –
options – Additional map of options

Returns:

java.util.Set<uk.gov.gchq.gaffer.store.StoreTrait>

CLASS = 'uk.gov.gchq.gaffer.store.operation.GetTraits'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetVariable(variable_name: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets a variable from the Context variable map

Parameters:

variable_name –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.GetVariable'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.GetVariables(variable_names: List[str] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets all variables from the Context variable map

Parameters:

variable_names –
options – Additional map of options

Returns:

java.util.Map<java.lang.String,java.lang.Object>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.GetVariables'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Walks around the Graph, returning the full walks taken

Parameters:

input –
operations –
include_partial –
conditional –
results_limit –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.graph.Walk>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.GetWalks'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.HasTrait(current_traits: bool | None = None, trait: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

An Operation that will see if a Store has a given trait

Parameters:

current_traits –
trait – The features of the Gaffer store - i.e does it support query aggregation?
options – Additional map of options

Returns:

java.lang.Boolean

CLASS = 'uk.gov.gchq.gaffer.store.operation.HasTrait'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Conditionally runs an operation or an alternative operation

Parameters:

otherwise –
input –
condition –
conditional –
multi_input_wrapper –
then –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.If'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ImportAccumuloKeyValueFiles(input_path: str, failure_path: str, options: Dict[str, str] | None = None)

Bases: Operation

Imports Accumulo key value files

Parameters:

input_path –
failure_path –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.accumulostore.operation.hdfs.operation.ImportAccumuloKeyValueFiles'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ImportFromLocalFile(file_path: str, job_id: str | None = None, key: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Fetches data from a local file

Parameters:

file_path –
job_id –
key –
options – Additional map of options

Returns:

java.lang.Iterable<java.lang.String>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.export.localfile.ImportFromLocalFile'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Joins two iterables based on a join type

Parameters:

flatten –
input –
join_type –
match_key –
collection_limit –
match_method –
operation –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.join.Join'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Limit(result_limit: int, input: List[Any] | None = None, truncate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Limits the number of items

Parameters:

result_limit –
input –
truncate –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.Limit'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Map(functions: List[Function], input: Any | None = None, function: Function | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Maps an input to an output using provided functions

Parameters:

functions –
input –
function –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.Map'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Max(comparators: List[Any], input: List[Element] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Extracts the maximum element based on provided Comparators

Parameters:

comparators –
input –
options – Additional map of options

Returns:

uk.gov.gchq.gaffer.data.element.Element

CLASS = 'uk.gov.gchq.gaffer.operation.impl.compare.Max'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Min(comparators: List[Any], input: List[Element] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Extracts the minimum element based on provided Comparators

Parameters:

comparators –
input –
options – Additional map of options

Returns:

uk.gov.gchq.gaffer.data.element.Element

CLASS = 'uk.gov.gchq.gaffer.operation.impl.compare.Min'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.NamedOperation(operation_name: str, input: List[Any] | None = None, parameters: Dict[str, Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Runs a named operation

Parameters:

operation_name –
input –
parameters –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.named.operation.NamedOperation'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.OperationChain(operations: List[Operation] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

A chain of operations where the results are passed between each operation

Parameters:

operations –
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.OperationChain'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.OperationChainDAO(operations, options=None)

Bases: OperationChain

Simple data access object, enabling (de)serialisation of an OperationChain

CLASS = 'uk.gov.gchq.gaffer.operation.OperationChainDAO'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Reduce(aggregate_function: BinaryOperator, input: List[Any] | None = None, identity: Any | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Reduces an input to an output with a single value using provided function

Parameters:

aggregate_function –
input –
identity –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.Reduce'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.RemoveGraph(graph_id: str, remove_cache: bool | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Removes a Graph from the federated store

Parameters:

graph_id –
remove_cache –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Boolean

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.RemoveGraph'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.RemoveGraphAndDeleteAllData(remove_cache: bool | None = None, graph_id: str | None = None, user_requesting_admin_usage: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Used to tell a graph to delete all data, before being removed.

Parameters:

remove_cache –
graph_id –
user_requesting_admin_usage –
options – Additional map of options

Returns:

java.lang.Boolean

CLASS = 'uk.gov.gchq.gaffer.federatedstore.operation.RemoveGraphAndDeleteAllData'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.SampleDataForSplitPoints(splits_file_path: str, job_initialiser: Any, input_mapper_pairs: Dict[str, str], output_path: str, num_map_tasks: int | None = None, min_reduce_tasks: int | None = None, num_splits: int | None = None, max_reduce_tasks: int | None = None, min_map_tasks: int | None = None, use_provided_splits: bool | None = None, command_line_args: List[str] | None = None, compression_codec: Any | None = None, partitioner: Any | None = None, proportion_to_sample: float | None = None, max_map_tasks: int | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Creates a splits file by sampling given data

Parameters:

splits_file_path –
job_initialiser –
input_mapper_pairs –
output_path –
num_map_tasks –
min_reduce_tasks –
num_splits –
max_reduce_tasks –
min_map_tasks –
use_provided_splits –
command_line_args –
compression_codec –
partitioner –
proportion_to_sample –
max_map_tasks –
validate –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.hdfs.operation.SampleDataForSplitPoints'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.SampleElementsForSplitPoints(input: List[Element] | None = None, num_splits: int | None = None, proportion_to_sample: float | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Samples an iterable of elements and generates split points

Parameters:

input –
num_splits –
proportion_to_sample –
options – Additional map of options

Returns:

java.util.List<T>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.SampleElementsForSplitPoints'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ScoreOperationChain(operation_chain: OperationChain | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Scores an OperationChain

Parameters:

operation_chain – A chain of operations where the results are passed between each operation
options – Additional map of options

Returns:

java.lang.Integer

CLASS = 'uk.gov.gchq.gaffer.operation.impl.ScoreOperationChain'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.SetVariable(input: Any | None = None, variable_name: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Sets a variable in the Context

Parameters:

input –
variable_name –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.SetVariable'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Sort(comparators: List[Any], input: List[Element] | None = None, result_limit: int | None = None, deduplicate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Sorts elements based on provided Comparators and can be used to extract the top ‘n’ elements

Parameters:

comparators –
input –
result_limit –
deduplicate –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.compare.Sort'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.SplitStoreFromFile(input_path: str, options: Dict[str, str] | None = None)

Bases: Operation

Splits a store based on a file of split points

Parameters:

input_path –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.SplitStoreFromFile'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.SplitStoreFromIterable(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Splits a store based on an iterable of split points

Parameters:

input –
options – Additional map of options

Returns:

java.lang.Void

CLASS = 'uk.gov.gchq.gaffer.operation.impl.SplitStoreFromIterable'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.SummariseGroupOverRanges(input: List[Tuple[ElementSeed, ElementSeed]] | None = None, view: View | None = None, include_incoming_out_going: str | None = None, directed_type: str | None = None, views: List[View] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Gets summarised Elements for each group

Parameters:

input –
view –
include_incoming_out_going – Should the edges point towards, or away from your seeds
directed_type – Is the Edge directed?
views –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.accumulostore.operation.impl.SummariseGroupOverRanges'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToArray(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts an Iterable to an Array

Parameters:

input –
options – Additional map of options

Returns:

java.lang.Object[]

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToArray'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToCsv(input: List[Element] | None = None, csv_generator: CsvGenerator | None = None, include_header: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts elements to CSV Strings

Parameters:

input –
csv_generator – Generates a CSV string for each element
include_header –
options – Additional map of options

Returns:

java.lang.Iterable<java.lang.String>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToCsv'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToEntitySeeds(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts an objects into EntitySeeds

Parameters:

input –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.operation.data.EntitySeed>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToEntitySeeds'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToList(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts an Iterable to a List

Parameters:

input –
options – Additional map of options

Returns:

java.util.List<T>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToList'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToMap(element_generator: MapGenerator, input: List[Element] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts elements to a Map of key-value pairs

Parameters:

element_generator – Generates a Map for each element
input –
options – Additional map of options

Returns:

java.lang.Iterable<java.util.Map<java.lang.String,java.lang.Object>>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToMap'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToSet(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts an Iterable to a Set

Parameters:

input –
options – Additional map of options

Returns:

java.util.Set<T>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToSet'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToSingletonList(input: Any | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts a single input of type T to a List

Parameters:

input –
options – Additional map of options

Returns:

java.util.List<T>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToSingletonList'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToStream(input: List[Any] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts an Iterable to a Stream

Parameters:

input –
options – Additional map of options

Returns:

java.util.stream.Stream<T>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToStream'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ToVertices(input: List[ElementSeed] | None = None, use_matched_vertex: str | None = None, edge_vertices: str | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Converts element ids into vertices

Parameters:

input –
use_matched_vertex – Choose whether to extract vertices based on how the seeds match the edges
edge_vertices – Choose whether to extract the edge vertices
options – Additional map of options

Returns:

java.lang.Iterable<?>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.output.ToVertices'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Transform(input: List[Element] | None = None, entities: Dict[str, ElementTransformer] | None = None, edges: Dict[str, ElementTransformer] | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Transforms elements

Parameters:

input –
entities –
edges –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.function.Transform'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.Validate(input: List[Element] | None = None, skip_invalid_elements: bool | None = None, validate: bool | None = None, options: Dict[str, str] | None = None)

Bases: Operation

Validates elements based on the schema

Parameters:

input –
skip_invalid_elements –
validate –
options – Additional map of options

Returns:

java.lang.Iterable<uk.gov.gchq.gaffer.data.element.Element>

CLASS = 'uk.gov.gchq.gaffer.operation.impl.Validate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.operations.ValidateOperationChain(operation_chain: OperationChain, options: Dict[str, str] | None = None)

Bases: Operation

Validates an OperationChain

Parameters:

operation_chain – A chain of operations where the results are passed between each operation
options – Additional map of options

Returns:

uk.gov.gchq.koryphe.ValidationResult

CLASS = 'uk.gov.gchq.gaffer.operation.impl.ValidateOperationChain'

to_json(): Converts an object to a simple json dictionary

Bases: Operation

Repeatedly executes an operation while a condition is met

Parameters:

input –
condition –
conditional –
max_repeats –
multi_input_wrapper –
operation –
options – Additional map of options

Returns:

java.lang.Object

CLASS = 'uk.gov.gchq.gaffer.operation.impl.While'

to_json(): Converts an object to a simple json dictionary

gafferpy.generated_api.predicates module

This module has been generated with fishbowl. To make changes, either extend these classes or change fishbowl.

class gafferpy.generated_api.predicates.AdaptedPredicate(predicate: Predicate | None = None, input_adapter: Function | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.predicate.AdaptedPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.AgeOff(age_off_hours: int | None = None, age_off_days: int | None = None, age_off_time: int | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.AgeOff'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.AgeOffFromDays

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.AgeOffFromDays'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.AggregatorUtilIsElementAggregated

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.store.util.AggregatorUtil$IsElementAggregated'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.And(predicates: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.And'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.AreEqual

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.AreEqual'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.AreIn(values: List[Any] | None = None, null_or_empty_values_accepted: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.AreIn'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.CollectionContains(value: Any | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.CollectionContains'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.DefaultUserPredicate(auths: List[str] | None = None, creating_user_id: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.access.predicate.user.DefaultUserPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.ElementFilter(predicates: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.data.element.function.ElementFilter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.ElementJoinComparator(group_by_properties: Set[str] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.data.element.comparison.ElementJoinComparator'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.ExampleFilterFunction

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.rest.example.ExampleFilterFunction'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.Exists

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.Exists'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.FederatedGraphReadUserPredicate(public: bool | None = None, auths: List[str] | None = None, creating_user_id: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.federatedstore.access.predicate.user.FederatedGraphReadUserPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.FederatedGraphWriteUserPredicate(creating_user_id: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.federatedstore.access.predicate.user.FederatedGraphWriteUserPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.HllSketchIsLessThan(value: int | None = None, or_equal_to: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.sketches.datasketches.cardinality.predicate.HllSketchIsLessThan'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.HyperLogLogPlusIsLessThan(value: int | None = None, or_equal_to: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.sketches.clearspring.cardinality.predicate.HyperLogLogPlusIsLessThan'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.If(otherwise: Predicate | None = None, predicate: Predicate | None = None, condition: bool | None = None, then: Predicate | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.If'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.range.InDateRange'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.range.InDateRangeDual'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.InRange(start_inclusive: bool | None = None, start: Any | None = None, end: Any | None = None, end_inclusive: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.range.InRange'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.range.InRangeDual'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.range.InTimeRange'

to_json(): Converts an object to a simple json dictionary

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.range.InTimeRangeDual'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IntegerTupleAdaptedPredicate(predicate: Predicate | None = None, input_adapter: Function | None = None, selection: List[int] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.tuple.predicate.IntegerTupleAdaptedPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsA(type: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsA'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsEqual(value: Any | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsEqual'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsFalse

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsFalse'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsIn(values: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsIn'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsLessThan(value: Any | None = None, or_equal_to: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsLessThan'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsLongerThan(min_length: int | None = None, or_equal_to: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsLongerThan'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsMoreThan(value: Any | None = None, or_equal_to: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsMoreThan'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsShorterThan(max_length: int | None = None, or_equal_to: bool | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsShorterThan'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsTrue

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsTrue'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsXLessThanY

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsXLessThanY'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.IsXMoreThanY

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.IsXMoreThanY'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.MapContains(key: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.MapContains'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.MapContainsPredicate(key_predicate: Predicate | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.MapContainsPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.MultiRegex(value: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.MultiRegex'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.NamedViewWriteUserPredicate(auths: List[str] | None = None, creating_user_id: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.data.elementdefinition.view.access.predicate.user.NamedViewWriteUserPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.NoAccessUserPredicate

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.access.predicate.user.NoAccessUserPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.Not(predicate: Predicate | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.Not'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.Or(predicates: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.Or'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.PredicateComposite(predicates: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.predicate.PredicateComposite'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.PredicateMap(predicate: Predicate | None = None, key: Any | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.predicate.PredicateMap'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.PropertiesFilter(predicates: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.data.element.function.PropertiesFilter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.RBMBackedTimestampSetInRange(start_time: Any | None = None, end_time: Any | None = None, include_all_timestamps: bool | None = None, time_unit: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.time.predicate.RBMBackedTimestampSetInRange'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.Regex(value: Any | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.Regex'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.StringContains(ignore_case: bool | None = None, value: str | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.impl.predicate.StringContains'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.TransformAndFilter(filter: ElementFilter | None = None, transformer: ElementTransformer | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.graph.hook.migrate.predicate.TransformAndFilter'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.TupleAdaptedPredicate(predicate: Predicate | None = None, input_adapter: Function | None = None, selection: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicate'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.TupleAdaptedPredicateComposite(predicates: List[Any] | None = None)

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.koryphe.tuple.predicate.TupleAdaptedPredicateComposite'

to_json(): Converts an object to a simple json dictionary

class gafferpy.generated_api.predicates.UnrestrictedAccessUserPredicate

Bases: AbstractPredicate

CLASS = 'uk.gov.gchq.gaffer.access.predicate.user.UnrestrictedAccessUserPredicate'

to_json(): Converts an object to a simple json dictionary

gafferpy.generated_api package

Submodules

gafferpy.generated_api.binary_operators module

gafferpy.generated_api.config module

gafferpy.generated_api.functions module

gafferpy.generated_api.operations module

gafferpy.generated_api.predicates module

Module contents