Interface GraphQLErrorObject
- All Known Subinterfaces:
GraphQLAgentBusinessUnitAmbiguousError,GraphQLAgentBusinessUnitLimitExceededError,GraphQLAgentBusinessUnitUnresolvedError,GraphQLAgentExtractionFailedError,GraphQLAgentFeatureDisabledError,GraphQLAgentMissingCountryError,GraphQLAgentMissingCustomerEmailError,GraphQLAgentMissingEntityTypeError,GraphQLAgentMissingShoppingListNameError,GraphQLAgentNoLineItemsExtractedError,GraphQLAgentOutOfScopeError,GraphQLAgentProductSearchNotEnabledError,GraphQLAgentProductsNotFoundError,GraphQLAgentQuoteRequestCreationFailedError,GraphQLAgentShoppingListCreationFailedError,GraphQLAgentStoreAmbiguousError,GraphQLAgentStoreDistributionChannelsUnsupportedError,GraphQLAgentStoreUnresolvedError,GraphQLAnonymousIdAlreadyInUseError,GraphQLAssociateMissingPermissionError,GraphQLAttributeDefinitionAlreadyExistsError,GraphQLAttributeDefinitionTypeConflictError,GraphQLAttributeNameDoesNotExistError,GraphQLBadGatewayError,GraphQLBulkOperationMaxItemsExceededError,GraphQLConcurrentModificationError,GraphQLContentTooLargeError,GraphQLCountryNotConfiguredInStoreError,GraphQLDiscountCodeNonApplicableError,GraphQLDuplicateAttributeValueError,GraphQLDuplicateAttributeValuesError,GraphQLDuplicateEnumValuesError,GraphQLDuplicateFieldError,GraphQLDuplicateFieldWithConflictingResourceError,GraphQLDuplicatePriceKeyError,GraphQLDuplicatePriceScopeError,GraphQLDuplicateStandalonePriceScopeError,GraphQLDuplicateVariantValuesError,GraphQLEditPreviewFailedError,GraphQLEnumKeyAlreadyExistsError,GraphQLEnumKeyDoesNotExistError,GraphQLEnumValueIsUsedError,GraphQLEnumValuesMustMatchError,GraphQLExactLockConflictError,GraphQLExpiredCustomerEmailTokenError,GraphQLExpiredCustomerPasswordTokenError,GraphQLExtensionBadResponseError,GraphQLExtensionChainTooDeepError,GraphQLExtensionChainTooWideError,GraphQLExtensionCircularDependencyError,GraphQLExtensionDependencyExistsError,GraphQLExtensionNoResponseError,GraphQLExtensionPredicateEvaluationFailedError,GraphQLExtensionUpdateActionsFailedError,GraphQLExternalOAuthFailedError,GraphQLFeatureRemovedError,GraphQLGeneralError,GraphQLInsufficientScopeError,GraphQLInternalConstraintViolatedError,GraphQLInvalidCredentialsError,GraphQLInvalidCurrentPasswordError,GraphQLInvalidFieldError,GraphQLInvalidInputError,GraphQLInvalidItemShippingDetailsError,GraphQLInvalidJsonInputError,GraphQLInvalidOperationError,GraphQLInvalidSubjectError,GraphQLInvalidTokenError,GraphQLLanguageUsedInStoresError,GraphQLLineItemQuantityAboveLimitError,GraphQLLineItemQuantityBelowLimitError,GraphQLLockedFieldError,GraphQLMatchingPriceNotFoundError,GraphQLMaxCartDiscountsReachedError,GraphQLMaxDiscountGroupsReachedError,GraphQLMaxResourceLimitExceededError,GraphQLMaxStoreReferencesReachedError,GraphQLMissingRoleOnChannelError,GraphQLMissingTaxRateForCountryError,GraphQLMoneyOverflowError,GraphQLNoMatchingProductDiscountFoundError,GraphQLObjectNotFoundError,GraphQLOutOfStockError,GraphQLOverCapacityError,GraphQLOverlappingPriceValidityError,GraphQLOverlappingStandalonePriceValidityError,GraphQLPendingOperationError,GraphQLPriceChangedError,GraphQLProductAssignmentMissingError,GraphQLProductPresentWithDifferentVariantSelectionError,GraphQLProjectNotConfiguredForLanguagesError,GraphQLQueryComplexityLimitExceededError,GraphQLQueryTimedOutError,GraphQLRecurringOrderFailureError,GraphQLReferencedResourceNotFoundError,GraphQLReferenceExistsError,GraphQLRequiredFieldError,GraphQLResourceNotFoundError,GraphQLResourceSizeLimitExceededError,GraphQLSearchDeactivatedError,GraphQLSearchExecutionFailureError,GraphQLSearchFacetPathNotFoundError,GraphQLSearchIndexingInProgressError,GraphQLSearchNotReadyError,GraphQLSemanticErrorError,GraphQLShippingMethodDoesNotMatchCartError,GraphQLStoreCartDiscountsLimitReachedError,GraphQLSyntaxErrorError,GraphQLUnauthorizedError,GraphQLValidityLockConflictError
public interface GraphQLErrorObject
Represents a single error.
Example to create a subtype instance using the builder pattern
GraphQLErrorObject graphQLErrorObject = GraphQLErrorObject.businessUnitAmbiguousBuilder()
.build()
-
Method Summary
Modifier and TypeMethodDescriptionbuilder for anonymousIdAlreadyInUse subtypebuilder for associateMissingPermission subtypebuilder for attributeDefinitionAlreadyExists subtypebuilder for attributeDefinitionTypeConflict subtypebuilder for attributeNameDoesNotExist subtypebuilder for badGateway subtypebuilder for bulkOperationMaxItemsExceeded subtypebuilder for businessUnitAmbiguous subtypebuilder for businessUnitLimitExceeded subtypebuilder for businessUnitUnresolved subtypebuilder for concurrentModification subtypebuilder for contentTooLarge subtypecopyDeep()builder for countryNotConfiguredInStore subtypestatic GraphQLErrorObjectdeepCopy(GraphQLErrorObject template) factory method to create a deep copy of GraphQLErrorObjectbuilder for discountCodeNonApplicable subtypebuilder for duplicateAttributeValue subtypebuilder for duplicateAttributeValues subtypebuilder for duplicateEnumValues subtypebuilder for duplicateField subtypebuilder for duplicateFieldWithConflictingResource subtypebuilder for duplicatePriceKey subtypebuilder for duplicatePriceScope subtypebuilder for duplicateStandalonePriceScope subtypebuilder for duplicateVariantValues subtypebuilder for editPreviewFailed subtypebuilder for enumKeyAlreadyExists subtypebuilder for enumKeyDoesNotExist subtypebuilder for enumValueIsUsed subtypebuilder for enumValuesMustMatch subtypebuilder for exactLockConflict subtypebuilder for expiredCustomerEmailToken subtypebuilder for expiredCustomerPasswordToken subtypebuilder for extensionBadResponse subtypebuilder for extensionChainTooDeep subtypebuilder for extensionChainTooWide subtypebuilder for extensionCircularDependency subtypebuilder for extensionDependencyExists subtypebuilder for extensionNoResponse subtypebuilder for extensionPredicateEvaluationFailed subtypebuilder for extensionUpdateActionsFailed subtypebuilder for externalOAuthFailed subtypebuilder for extractionFailed subtypebuilder for featureDisabled subtypebuilder for featureRemoved subtypestatic GraphQLGeneralErrorBuilderbuilder for general subtype@NotNull StringgetCode()One of the error codes that is listed on the Errors page.builder for insufficientScope subtypebuilder for internalConstraintViolated subtypebuilder for invalidCredentials subtypebuilder for invalidCurrentPassword subtypebuilder for invalidField subtypebuilder for invalidInput subtypebuilder for invalidItemShippingDetails subtypebuilder for invalidJsonInput subtypebuilder for invalidOperation subtypebuilder for invalidSubject subtypebuilder for invalidToken subtypebuilder for languageUsedInStores subtypebuilder for lineItemQuantityAboveLimit subtypebuilder for lineItemQuantityBelowLimit subtypebuilder for lockedField subtypebuilder for matchingPriceNotFound subtypebuilder for maxCartDiscountsReached subtypebuilder for maxDiscountGroupsReached subtypebuilder for maxResourceLimitExceeded subtypebuilder for maxStoreReferencesReached subtypebuilder for missingCountry subtypebuilder for missingCustomerEmail subtypebuilder for missingEntityType subtypebuilder for missingRoleOnChannel subtypebuilder for missingShoppingListName subtypebuilder for missingTaxRateForCountry subtypebuilder for moneyOverflow subtypebuilder for noLineItemsExtracted subtypebuilder for noMatchingProductDiscountFound subtypebuilder for objectNotFound subtypebuilder for outOfScope subtypebuilder for outOfStock subtypebuilder for overCapacity subtypebuilder for overlappingPriceValidity subtypebuilder for overlappingStandalonePriceValidity subtypebuilder for pendingOperation subtypebuilder for priceChanged subtypebuilder for productAssignmentMissing subtypebuilder for productPresentWithDifferentVariantSelection subtypebuilder for productSearchNotEnabled subtypebuilder for productsNotFound subtypebuilder for projectNotConfiguredForLanguages subtypebuilder for queryComplexityLimitExceeded subtypebuilder for queryTimedOut subtypebuilder for quoteRequestCreationFailed subtypebuilder for recurringOrderFailure subtypebuilder for referencedResourceNotFound subtypebuilder for referenceExists subtypebuilder for requiredField subtypebuilder for resourceNotFound subtypebuilder for resourceSizeLimitExceeded subtypebuilder for searchDeactivated subtypebuilder for searchExecutionFailure subtypebuilder for searchFacetPathNotFound subtypebuilder for searchIndexingInProgress subtypebuilder for searchNotReady subtypebuilder for semanticError subtypevoidError-specific additional fields.builder for shippingMethodDoesNotMatchCart subtypebuilder for shoppingListCreationFailed subtypebuilder for storeAmbiguous subtypebuilder for storeCartDiscountsLimitReached subtypebuilder for storeDistributionChannelsUnsupported subtypebuilder for storeUnresolved subtypebuilder for syntaxError subtypestatic tools.jackson.core.type.TypeReference<GraphQLErrorObject>gives a TypeReference for usage with Jackson DataBindbuilder for unauthorized subtypebuilder for validityLockConflict subtypevalues()Error-specific additional fields.default <T> TwithGraphQLErrorObject(Function<GraphQLErrorObject, T> helper) accessor map function
-
Method Details
-
getCode
One of the error codes that is listed on the Errors page.
- Returns:
- code
-
values
Error-specific additional fields.
- Returns:
- map of the pattern property values
-
setValue
Error-specific additional fields.
- Parameters:
key- property namevalue- property value
-
copyDeep
GraphQLErrorObject copyDeep() -
deepCopy
factory method to create a deep copy of GraphQLErrorObject- Parameters:
template- instance to be copied- Returns:
- copy instance
-
businessUnitAmbiguousBuilder
builder for businessUnitAmbiguous subtype- Returns:
- builder
-
businessUnitLimitExceededBuilder
builder for businessUnitLimitExceeded subtype- Returns:
- builder
-
businessUnitUnresolvedBuilder
builder for businessUnitUnresolved subtype- Returns:
- builder
-
extractionFailedBuilder
builder for extractionFailed subtype- Returns:
- builder
-
featureDisabledBuilder
builder for featureDisabled subtype- Returns:
- builder
-
missingCountryBuilder
builder for missingCountry subtype- Returns:
- builder
-
missingCustomerEmailBuilder
builder for missingCustomerEmail subtype- Returns:
- builder
-
missingEntityTypeBuilder
builder for missingEntityType subtype- Returns:
- builder
-
missingShoppingListNameBuilder
builder for missingShoppingListName subtype- Returns:
- builder
-
noLineItemsExtractedBuilder
builder for noLineItemsExtracted subtype- Returns:
- builder
-
outOfScopeBuilder
builder for outOfScope subtype- Returns:
- builder
-
productSearchNotEnabledBuilder
builder for productSearchNotEnabled subtype- Returns:
- builder
-
productsNotFoundBuilder
builder for productsNotFound subtype- Returns:
- builder
-
quoteRequestCreationFailedBuilder
builder for quoteRequestCreationFailed subtype- Returns:
- builder
-
shoppingListCreationFailedBuilder
builder for shoppingListCreationFailed subtype- Returns:
- builder
-
storeAmbiguousBuilder
builder for storeAmbiguous subtype- Returns:
- builder
-
storeDistributionChannelsUnsupportedBuilder
static GraphQLAgentStoreDistributionChannelsUnsupportedErrorBuilder storeDistributionChannelsUnsupportedBuilder()builder for storeDistributionChannelsUnsupported subtype- Returns:
- builder
-
storeUnresolvedBuilder
builder for storeUnresolved subtype- Returns:
- builder
-
anonymousIdAlreadyInUseBuilder
builder for anonymousIdAlreadyInUse subtype- Returns:
- builder
-
associateMissingPermissionBuilder
builder for associateMissingPermission subtype- Returns:
- builder
-
attributeDefinitionAlreadyExistsBuilder
static GraphQLAttributeDefinitionAlreadyExistsErrorBuilder attributeDefinitionAlreadyExistsBuilder()builder for attributeDefinitionAlreadyExists subtype- Returns:
- builder
-
attributeDefinitionTypeConflictBuilder
builder for attributeDefinitionTypeConflict subtype- Returns:
- builder
-
attributeNameDoesNotExistBuilder
builder for attributeNameDoesNotExist subtype- Returns:
- builder
-
badGatewayBuilder
builder for badGateway subtype- Returns:
- builder
-
bulkOperationMaxItemsExceededBuilder
builder for bulkOperationMaxItemsExceeded subtype- Returns:
- builder
-
concurrentModificationBuilder
builder for concurrentModification subtype- Returns:
- builder
-
contentTooLargeBuilder
builder for contentTooLarge subtype- Returns:
- builder
-
countryNotConfiguredInStoreBuilder
builder for countryNotConfiguredInStore subtype- Returns:
- builder
-
discountCodeNonApplicableBuilder
builder for discountCodeNonApplicable subtype- Returns:
- builder
-
duplicateAttributeValueBuilder
builder for duplicateAttributeValue subtype- Returns:
- builder
-
duplicateAttributeValuesBuilder
builder for duplicateAttributeValues subtype- Returns:
- builder
-
duplicateEnumValuesBuilder
builder for duplicateEnumValues subtype- Returns:
- builder
-
duplicateFieldBuilder
builder for duplicateField subtype- Returns:
- builder
-
duplicateFieldWithConflictingResourceBuilder
static GraphQLDuplicateFieldWithConflictingResourceErrorBuilder duplicateFieldWithConflictingResourceBuilder()builder for duplicateFieldWithConflictingResource subtype- Returns:
- builder
-
duplicatePriceKeyBuilder
builder for duplicatePriceKey subtype- Returns:
- builder
-
duplicatePriceScopeBuilder
builder for duplicatePriceScope subtype- Returns:
- builder
-
duplicateStandalonePriceScopeBuilder
builder for duplicateStandalonePriceScope subtype- Returns:
- builder
-
duplicateVariantValuesBuilder
builder for duplicateVariantValues subtype- Returns:
- builder
-
editPreviewFailedBuilder
builder for editPreviewFailed subtype- Returns:
- builder
-
enumKeyAlreadyExistsBuilder
builder for enumKeyAlreadyExists subtype- Returns:
- builder
-
enumKeyDoesNotExistBuilder
builder for enumKeyDoesNotExist subtype- Returns:
- builder
-
enumValueIsUsedBuilder
builder for enumValueIsUsed subtype- Returns:
- builder
-
enumValuesMustMatchBuilder
builder for enumValuesMustMatch subtype- Returns:
- builder
-
exactLockConflictBuilder
builder for exactLockConflict subtype- Returns:
- builder
-
expiredCustomerEmailTokenBuilder
builder for expiredCustomerEmailToken subtype- Returns:
- builder
-
expiredCustomerPasswordTokenBuilder
builder for expiredCustomerPasswordToken subtype- Returns:
- builder
-
extensionBadResponseBuilder
builder for extensionBadResponse subtype- Returns:
- builder
-
extensionChainTooDeepBuilder
builder for extensionChainTooDeep subtype- Returns:
- builder
-
extensionChainTooWideBuilder
builder for extensionChainTooWide subtype- Returns:
- builder
-
extensionCircularDependencyBuilder
builder for extensionCircularDependency subtype- Returns:
- builder
-
extensionDependencyExistsBuilder
builder for extensionDependencyExists subtype- Returns:
- builder
-
extensionNoResponseBuilder
builder for extensionNoResponse subtype- Returns:
- builder
-
extensionPredicateEvaluationFailedBuilder
static GraphQLExtensionPredicateEvaluationFailedErrorBuilder extensionPredicateEvaluationFailedBuilder()builder for extensionPredicateEvaluationFailed subtype- Returns:
- builder
-
extensionUpdateActionsFailedBuilder
builder for extensionUpdateActionsFailed subtype- Returns:
- builder
-
externalOAuthFailedBuilder
builder for externalOAuthFailed subtype- Returns:
- builder
-
featureRemovedBuilder
builder for featureRemoved subtype- Returns:
- builder
-
generalBuilder
builder for general subtype- Returns:
- builder
-
insufficientScopeBuilder
builder for insufficientScope subtype- Returns:
- builder
-
internalConstraintViolatedBuilder
builder for internalConstraintViolated subtype- Returns:
- builder
-
invalidCredentialsBuilder
builder for invalidCredentials subtype- Returns:
- builder
-
invalidCurrentPasswordBuilder
builder for invalidCurrentPassword subtype- Returns:
- builder
-
invalidFieldBuilder
builder for invalidField subtype- Returns:
- builder
-
invalidInputBuilder
builder for invalidInput subtype- Returns:
- builder
-
invalidItemShippingDetailsBuilder
builder for invalidItemShippingDetails subtype- Returns:
- builder
-
invalidJsonInputBuilder
builder for invalidJsonInput subtype- Returns:
- builder
-
invalidOperationBuilder
builder for invalidOperation subtype- Returns:
- builder
-
invalidSubjectBuilder
builder for invalidSubject subtype- Returns:
- builder
-
invalidTokenBuilder
builder for invalidToken subtype- Returns:
- builder
-
languageUsedInStoresBuilder
builder for languageUsedInStores subtype- Returns:
- builder
-
lineItemQuantityAboveLimitBuilder
builder for lineItemQuantityAboveLimit subtype- Returns:
- builder
-
lineItemQuantityBelowLimitBuilder
builder for lineItemQuantityBelowLimit subtype- Returns:
- builder
-
lockedFieldBuilder
builder for lockedField subtype- Returns:
- builder
-
matchingPriceNotFoundBuilder
builder for matchingPriceNotFound subtype- Returns:
- builder
-
maxCartDiscountsReachedBuilder
builder for maxCartDiscountsReached subtype- Returns:
- builder
-
maxDiscountGroupsReachedBuilder
builder for maxDiscountGroupsReached subtype- Returns:
- builder
-
maxResourceLimitExceededBuilder
builder for maxResourceLimitExceeded subtype- Returns:
- builder
-
maxStoreReferencesReachedBuilder
builder for maxStoreReferencesReached subtype- Returns:
- builder
-
missingRoleOnChannelBuilder
builder for missingRoleOnChannel subtype- Returns:
- builder
-
missingTaxRateForCountryBuilder
builder for missingTaxRateForCountry subtype- Returns:
- builder
-
moneyOverflowBuilder
builder for moneyOverflow subtype- Returns:
- builder
-
noMatchingProductDiscountFoundBuilder
builder for noMatchingProductDiscountFound subtype- Returns:
- builder
-
objectNotFoundBuilder
builder for objectNotFound subtype- Returns:
- builder
-
outOfStockBuilder
builder for outOfStock subtype- Returns:
- builder
-
overCapacityBuilder
builder for overCapacity subtype- Returns:
- builder
-
overlappingPriceValidityBuilder
builder for overlappingPriceValidity subtype- Returns:
- builder
-
overlappingStandalonePriceValidityBuilder
static GraphQLOverlappingStandalonePriceValidityErrorBuilder overlappingStandalonePriceValidityBuilder()builder for overlappingStandalonePriceValidity subtype- Returns:
- builder
-
pendingOperationBuilder
builder for pendingOperation subtype- Returns:
- builder
-
priceChangedBuilder
builder for priceChanged subtype- Returns:
- builder
-
productAssignmentMissingBuilder
builder for productAssignmentMissing subtype- Returns:
- builder
-
productPresentWithDifferentVariantSelectionBuilder
static GraphQLProductPresentWithDifferentVariantSelectionErrorBuilder productPresentWithDifferentVariantSelectionBuilder()builder for productPresentWithDifferentVariantSelection subtype- Returns:
- builder
-
projectNotConfiguredForLanguagesBuilder
static GraphQLProjectNotConfiguredForLanguagesErrorBuilder projectNotConfiguredForLanguagesBuilder()builder for projectNotConfiguredForLanguages subtype- Returns:
- builder
-
queryComplexityLimitExceededBuilder
builder for queryComplexityLimitExceeded subtype- Returns:
- builder
-
queryTimedOutBuilder
builder for queryTimedOut subtype- Returns:
- builder
-
recurringOrderFailureBuilder
builder for recurringOrderFailure subtype- Returns:
- builder
-
referenceExistsBuilder
builder for referenceExists subtype- Returns:
- builder
-
referencedResourceNotFoundBuilder
builder for referencedResourceNotFound subtype- Returns:
- builder
-
requiredFieldBuilder
builder for requiredField subtype- Returns:
- builder
-
resourceNotFoundBuilder
builder for resourceNotFound subtype- Returns:
- builder
-
resourceSizeLimitExceededBuilder
builder for resourceSizeLimitExceeded subtype- Returns:
- builder
-
searchDeactivatedBuilder
builder for searchDeactivated subtype- Returns:
- builder
-
searchExecutionFailureBuilder
builder for searchExecutionFailure subtype- Returns:
- builder
-
searchFacetPathNotFoundBuilder
builder for searchFacetPathNotFound subtype- Returns:
- builder
-
searchIndexingInProgressBuilder
builder for searchIndexingInProgress subtype- Returns:
- builder
-
searchNotReadyBuilder
builder for searchNotReady subtype- Returns:
- builder
-
semanticErrorBuilder
builder for semanticError subtype- Returns:
- builder
-
shippingMethodDoesNotMatchCartBuilder
builder for shippingMethodDoesNotMatchCart subtype- Returns:
- builder
-
storeCartDiscountsLimitReachedBuilder
builder for storeCartDiscountsLimitReached subtype- Returns:
- builder
-
syntaxErrorBuilder
builder for syntaxError subtype- Returns:
- builder
-
unauthorizedBuilder
builder for unauthorized subtype- Returns:
- builder
-
validityLockConflictBuilder
builder for validityLockConflict subtype- Returns:
- builder
-
withGraphQLErrorObject
accessor map function- Type Parameters:
T- mapped type- Parameters:
helper- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-