django_elasticsearch_dsl_drf.fields package

Submodules

django_elasticsearch_dsl_drf.fields.common module

Common fields.

class django_elasticsearch_dsl_drf.fields.common.BooleanField(**kwargs)[source]

Bases: rest_framework.fields.BooleanField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.common.CharField(**kwargs)[source]

Bases: rest_framework.fields.CharField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.common.DateField(format=<class 'rest_framework.fields.empty'>, input_formats=None, *args, **kwargs)[source]

Bases: rest_framework.fields.DateField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.common.FloatField(**kwargs)[source]

Bases: rest_framework.fields.FloatField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.common.IntegerField(**kwargs)[source]

Bases: rest_framework.fields.IntegerField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.common.IPAddressField(protocol='both', **kwargs)[source]

Bases: rest_framework.fields.IPAddressField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

django_elasticsearch_dsl_drf.fields.helpers module

Helpers.

django_elasticsearch_dsl_drf.fields.helpers.to_representation(value)[source]

To representation.

django_elasticsearch_dsl_drf.fields.nested_fields module

Nested fields.

class django_elasticsearch_dsl_drf.fields.nested_fields.GeoPointField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField

Geo point field.

class django_elasticsearch_dsl_drf.fields.nested_fields.GeoShapeField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField

Geo shape field.

class django_elasticsearch_dsl_drf.fields.nested_fields.NestedField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField

Nested field.

class django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: rest_framework.fields.Field

Object field.

get_value(dictionary)[source]

Get value.

to_internal_value(data)[source]

To internal value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.nested_fields.ListField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: rest_framework.fields.Field

List field.

get_value(dictionary)[source]

Get value.

to_internal_value(data)[source]

To internal value.

to_representation(value)[source]

To representation.

Module contents

Fields.

class django_elasticsearch_dsl_drf.fields.BooleanField(**kwargs)[source]

Bases: rest_framework.fields.BooleanField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.CharField(**kwargs)[source]

Bases: rest_framework.fields.CharField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.DateField(format=<class 'rest_framework.fields.empty'>, input_formats=None, *args, **kwargs)[source]

Bases: rest_framework.fields.DateField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.FloatField(**kwargs)[source]

Bases: rest_framework.fields.FloatField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.GeoPointField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField

Geo point field.

class django_elasticsearch_dsl_drf.fields.GeoShapeField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField

Geo shape field.

class django_elasticsearch_dsl_drf.fields.IntegerField(**kwargs)[source]

Bases: rest_framework.fields.IntegerField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.IPAddressField(protocol='both', **kwargs)[source]

Bases: rest_framework.fields.IPAddressField

Object field.

get_value(dictionary)[source]

Get value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.ListField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: rest_framework.fields.Field

List field.

get_value(dictionary)[source]

Get value.

to_internal_value(data)[source]

To internal value.

to_representation(value)[source]

To representation.

class django_elasticsearch_dsl_drf.fields.NestedField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: django_elasticsearch_dsl_drf.fields.nested_fields.ObjectField

Nested field.

class django_elasticsearch_dsl_drf.fields.ObjectField(read_only=False, write_only=False, required=None, default=<class 'rest_framework.fields.empty'>, initial=<class 'rest_framework.fields.empty'>, source=None, label=None, help_text=None, style=None, error_messages=None, validators=None, allow_null=False)[source]

Bases: rest_framework.fields.Field

Object field.

get_value(dictionary)[source]

Get value.

to_internal_value(data)[source]

To internal value.

to_representation(value)[source]

To representation.