Package org.graylog.plugins.views.search

Interface Parameter

All Superinterfaces:

ContentPackable<Parameter>

All Known Implementing Classes:

ValueParameter

public interface Parameter
extends ContentPackable<Parameter>

Parameters describe variable inputs to queries.

They consist of a declaration and a binding. Parameters without a binding are called "free" or "unbound" parameters. In order to execute a query all of its non-optional parameters must have a binding associated with them, i.e. be "bound".

The caller is expected to provide a Parameter object when binding previously declared parameters. In that case the declaration elements do not need to be repeated, only its name property.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Parameter.Binding
static interface	Parameter.BindingHandler<B extends Parameter.Binding,P extends Parameter>
static interface	Parameter.Builder<SELF>
static interface	Parameter.Factory<TYPE extends Parameter>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_FIELD

Method Summary

Modifier and Type	Method	Description
Parameter	applyBindings(Map<String,Parameter.Binding> bindings)
Parameter.Binding	binding()
String	dataType()
Object	defaultValue()
String	description()
String	name()
boolean	optional()
String	title()
default Parameter	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
String	type()

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage, resolveNativeEntity

Field Details

TYPE_FIELD

static final String TYPE_FIELD

See Also:

• Constant Field Values

Method Details

type

String type()

name

String name()

title

@Nullable
String title()

description

@Nullable
String description()

dataType

String dataType()

defaultValue

@Nullable
Object defaultValue()

optional

boolean optional()

binding

@Nullable
Parameter.Binding binding()

applyBindings

Parameter applyBindings(Map<String,Parameter.Binding> bindings)

toContentPackEntity

default Parameter toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<Parameter>