Common GraphQL Enums

Enums are a special schema type that represents a predefined list of possible values. This allows you to:

• Provide out-of-the-box validation on operations and data.
• Keep data values consistent by restricting a field to a smaller set of possible values.

Use this document to guide you in using various enums throughout Insites.

ACL

Code example:

Values

Private.

Public (read-only).

AggregationSortFieldEnum

Code example:

Values

Document count sort.

Alpha sort.

AggregationSortOrderEnum

Code example:

Values

Ascending.

Descending.

AggregationTypeEnum

Code example:

Values

A single-value metrics aggregation that keeps track and returns the average value among the values extracted from the aggregated documents.

A single-value metrics aggregation that keeps track and returns the maximum value among the values extracted from the aggregated documents.

A single-value metrics aggregation that keeps track and returns the minimum value among the values extracted from the aggregated documents.

A multi-bucket value source-based aggregation where buckets are dynamically built - one per unique value.

AsyncCallbackPriority

Code example:

Values

Default - max timeout: 5 minutes.

High - max timeout: 1 minute.

Low - max timeout: 4 hours.

AttachmentContentDispositionEnum

Code example:

Values

Download.

Inline.

AuthenticationProvider

List of authentication providers.

Values

auth0.

Facebook.

Github.

Google.

Instagram.

LinkedIn.

Openid_connect.

Saml.

Twitter.

BackgroundJobsTypeEnum

Background jobs type.

Values

Jobs that have failed max_attempts times and won't be retried anymore.

Jobs that have failed and are scheduled for a retry.

Jobs that are being processed at this moment.

Jobs that have been scheduled to be performed in the future.

CustomizableTypeEnum

Code example:

Values

Customization.

Transactable.

User.

User Profile.

DistanceUnit

Code example:

Values

Centimetres.

Kilometres.

Meters.

Miles.

Nautical Miles.

Yards.

ImageFormat

Code example:

Values

ImageResizeFit

Code example:

Values

Embed within both provided dimensions.

Crop to cover both provided dimensions.

Ignore the aspect ratio of the input and stretch to both provided dimensions.

Preserving the aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to those specified.

Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to those specified. Some of these values are based on the object-fit CSS property.

ImageResizePosition

Code example:

Values

JwtAlgorithm

Code example:

Values

LogEntryType

List of available event types.

Values

NotificationTypeEnum

Code example:

Values

OperatorEnum

Code example:

Values

All values should match.

Any value should match.

PageFormat

Code example:

Values

PageHandler

Code example:

Values

PageRedifectCode

Code example:

Values

301 Moved Permanently.

302 Moved Temporarily.

PageRequestMethod

Code example:

Values

ProcessStrategy

Code example:

Values

pdf - body should be HTML to be converted to pdf.

text - choose it for things like CSV, json, XML, plain text etc.

PropertyTargetType

Code example:

Values

PropertyTypeEnum

Code example:

Values

An array of strings will be deprecated as the current implementation prevents arrays of other types.

Deprecated; please use string.

PropertyUploadACL

Code example:

Values

PropertyUploadContentDisposition

Code example:

Values

PropertyUploadFit

Code example:

Values

Embed within both provided dimensions.

Crop to cover both provided dimensions.

Ignore the aspect ratio of the input and stretch to both provided dimensions.

Preserving the aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to those specified.

Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to those specified. Some of these values are based on the object-fit CSS property.

PropertyUploadFormat

Code example:

Values

PropertyUploadPosition

Code example:

Values

QueryMatchTypeEnum

Match types for keywords.

Values

Match any characters on start and end foo.

Match any characters on start *foo.

Match whole words.

Match and allow typos. Keywodr -> Keyword.

Match any characters on end foo*.

SortOrderEnum

Code example:

Values

For strings: , for numbers: .

For strings: , for numbers: .

TranslationJsonStrategy

Strategy how to set Translation JSON.

Values

Will do the deep merge with existing translations; nothing will be deleted.

It will remove all existing translations for the given key prefix and replace them with provided values.

UploadType

Code example:

Values

ValueUploadInputTypeEnum

Type for upload data.

Values

Image upload, generate versions.

Data for a PDF upload.

Data for a plain upload without any processing.

VersionAction

Code example:

Values

VersionItemType

Code example:

Values

Note

This topic is a compilation of knowledge found at Apollo GraphQL and GraphQL.org.