Package co.elastic.clients.elasticsearch.security

Class FieldRule

java.lang.Object

co.elastic.clients.elasticsearch.security.FieldRule

All Implemented Interfaces:

RoleMappingRuleVariant, JsonpSerializable, OpenTaggedUnion<FieldRule.Kind,Object>, TaggedUnion<FieldRule.Kind,Object>

@JsonpDeserializable
public class FieldRule
extends Object
implements OpenTaggedUnion<FieldRule.Kind,Object>, RoleMappingRuleVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldRule.Builder
static enum	FieldRule.Kind	FieldRule variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<FieldRule>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
FieldRule(FieldRuleVariant value)

Method Summary

Modifier and Type	Method	Description
JsonData	_custom()	Get the custom plugin-defined variant value.
final String	_customKind()	Get the actual kind when _kind() equals FieldRule.Kind._Custom (plugin-defined variant).
final Object	_get()
boolean	_isCustom()	Is this a custom FieldRule defined by a plugin?
final FieldRule.Kind	_kind()	Get the of the kind of variant held by this object.
RoleMappingRule.Kind	_roleMappingRuleKind()	RoleMappingRule variant kind.
List<String>	dn()	Get the dn variant value.
List<String>	groups()	Get the groups variant value.
boolean	isDn()	Is this variant instance of kind dn?
boolean	isGroups()	Is this variant instance of kind groups?
boolean	isUsername()	Is this variant instance of kind username?
static FieldRule	of(Function<FieldRule.Builder,ObjectBuilder<FieldRule>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFieldRuleDeserializer(ObjectDeserializer<FieldRule.Builder> op)
String	toString()
List<String>	username()	Get the username variant value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch.security.RoleMappingRuleVariant

_toRoleMappingRule

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FieldRule> _DESERIALIZER

Constructor Details

FieldRule

public FieldRule(FieldRuleVariant value)

Method Details

_roleMappingRuleKind

public RoleMappingRule.Kind _roleMappingRuleKind()

RoleMappingRule variant kind.

Specified by:

_roleMappingRuleKind in interface RoleMappingRuleVariant

_kind

public final FieldRule.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<FieldRule.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<FieldRule.Kind,Object>

of

public static FieldRule of(Function<FieldRule.Builder,ObjectBuilder<FieldRule>> fn)

isUsername

public boolean isUsername()

Is this variant instance of kind username?

username

public List<String> username()

Get the username variant value.

Throws:

IllegalStateException - if the current variant is not of the username kind.

isDn

public boolean isDn()

Is this variant instance of kind dn?

dn

public List<String> dn()

Get the dn variant value.

Throws:

IllegalStateException - if the current variant is not of the dn kind.

isGroups

public boolean isGroups()

Is this variant instance of kind groups?

groups

public List<String> groups()

Get the groups variant value.

Throws:

IllegalStateException - if the current variant is not of the groups kind.

_isCustom

public boolean _isCustom()

Is this a custom FieldRule defined by a plugin?

_customKind

@Nullable
public final String _customKind()

Get the actual kind when _kind() equals FieldRule.Kind._Custom (plugin-defined variant).

Specified by:

_customKind in interface OpenTaggedUnion<FieldRule.Kind,Object>

_custom

public JsonData _custom()

Get the custom plugin-defined variant value.

Throws:

IllegalStateException - if the current variant is not FieldRule.Kind._Custom.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupFieldRuleDeserializer

protected static void setupFieldRuleDeserializer(ObjectDeserializer<FieldRule.Builder> op)