Package com.commercetools.api.models.error

Class ExtensionBadResponseErrorBuilder

java.lang.Object
com.commercetools.api.models.error.ExtensionBadResponseErrorBuilder
All Implemented Interfaces:
Builder<ExtensionBadResponseError>
public class ExtensionBadResponseErrorBuilder extends Object implements Builder<ExtensionBadResponseError>
ExtensionBadResponseErrorBuilder
Example to create an instance using the builder pattern 

     ExtensionBadResponseError extensionBadResponseError = ExtensionBadResponseError.builder()
             .message("{message}")
             .plusExtensionErrors(extensionErrorsBuilder -> extensionErrorsBuilder)
             .extensionId("{extensionId}")
             .build()

  • Constructor Details

    • ExtensionBadResponseErrorBuilder

      public ExtensionBadResponseErrorBuilder()

  • Method Details

    • message

      public ExtensionBadResponseErrorBuilder message(String message)

      Description of the invalid Extension response. For example, "The extension did not return the expected JSON.".

      Parameters:
      message - value to be set
      Returns:
      Builder

    • values

      public ExtensionBadResponseErrorBuilder values(Map<String,Object> values)

      Error-specific additional fields.

      Parameters:
      values - properties to be set
      Returns:
      Builder

    • addValue

      public ExtensionBadResponseErrorBuilder addValue(String key, Object value)

      Error-specific additional fields.

      Parameters:
      key - property name
      value - property value
      Returns:
      Builder

    • localizedMessage

      public ExtensionBadResponseErrorBuilder localizedMessage(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

      User-defined localized description of the error.

      Parameters:
      builder - function to build the localizedMessage value
      Returns:
      Builder

    • withLocalizedMessage

      public ExtensionBadResponseErrorBuilder withLocalizedMessage(Function<LocalizedStringBuilder,LocalizedString> builder)

      User-defined localized description of the error.

      Parameters:
      builder - function to build the localizedMessage value
      Returns:
      Builder

    • localizedMessage

      public ExtensionBadResponseErrorBuilder localizedMessage(@Nullable LocalizedString localizedMessage)

      User-defined localized description of the error.

      Parameters:
      localizedMessage - value to be set
      Returns:
      Builder

    • extensionExtraInfo

      public ExtensionBadResponseErrorBuilder extensionExtraInfo(@Nullable Object extensionExtraInfo)

      Any information that should be returned to the API caller.

      Parameters:
      extensionExtraInfo - value to be set
      Returns:
      Builder

    • extensionErrors

      public ExtensionBadResponseErrorBuilder extensionErrors(ExtensionError... extensionErrors)

      Additional errors related to the API Extension.

      Parameters:
      extensionErrors - value to be set
      Returns:
      Builder

    • extensionErrors

      public ExtensionBadResponseErrorBuilder extensionErrors(List<ExtensionError> extensionErrors)

      Additional errors related to the API Extension.

      Parameters:
      extensionErrors - value to be set
      Returns:
      Builder

    • plusExtensionErrors

      public ExtensionBadResponseErrorBuilder plusExtensionErrors(ExtensionError... extensionErrors)

      Additional errors related to the API Extension.

      Parameters:
      extensionErrors - value to be set
      Returns:
      Builder

    • plusExtensionErrors

      public ExtensionBadResponseErrorBuilder plusExtensionErrors(Function<ExtensionErrorBuilder,ExtensionErrorBuilder> builder)

      Additional errors related to the API Extension.

      Parameters:
      builder - function to build the extensionErrors value
      Returns:
      Builder

    • withExtensionErrors

      public ExtensionBadResponseErrorBuilder withExtensionErrors(Function<ExtensionErrorBuilder,ExtensionErrorBuilder> builder)

      Additional errors related to the API Extension.

      Parameters:
      builder - function to build the extensionErrors value
      Returns:
      Builder

    • addExtensionErrors

      public ExtensionBadResponseErrorBuilder addExtensionErrors(Function<ExtensionErrorBuilder,ExtensionError> builder)

      Additional errors related to the API Extension.

      Parameters:
      builder - function to build the extensionErrors value
      Returns:
      Builder

    • setExtensionErrors

      public ExtensionBadResponseErrorBuilder setExtensionErrors(Function<ExtensionErrorBuilder,ExtensionError> builder)

      Additional errors related to the API Extension.

      Parameters:
      builder - function to build the extensionErrors value
      Returns:
      Builder

    • extensionBody

      public ExtensionBadResponseErrorBuilder extensionBody(@Nullable String extensionBody)

      The response body returned by the Extension.

      Parameters:
      extensionBody - value to be set
      Returns:
      Builder

    • extensionStatusCode

      public ExtensionBadResponseErrorBuilder extensionStatusCode(@Nullable Integer extensionStatusCode)

      Http status code returned by the Extension.

      Parameters:
      extensionStatusCode - value to be set
      Returns:
      Builder

    • extensionId

      public ExtensionBadResponseErrorBuilder extensionId(String extensionId)

      Unique identifier of the Extension.

      Parameters:
      extensionId - value to be set
      Returns:
      Builder

    • extensionKey

      public ExtensionBadResponseErrorBuilder extensionKey(@Nullable String extensionKey)

      User-defined unique identifier of the Extension.

      Parameters:
      extensionKey - value to be set
      Returns:
      Builder

    • getMessage

      public String getMessage()

      Description of the invalid Extension response. For example, "The extension did not return the expected JSON.".

      Returns:
      message

    • getValues

      public Map<String,Object> getValues()

      Error-specific additional fields.

      Returns:
      pattern properties

    • getLocalizedMessage

      @Nullable public LocalizedString getLocalizedMessage()

      User-defined localized description of the error.

      Returns:
      localizedMessage

    • getExtensionExtraInfo

      @Nullable public Object getExtensionExtraInfo()

      Any information that should be returned to the API caller.

      Returns:
      extensionExtraInfo

    • getExtensionErrors

      public List<ExtensionError> getExtensionErrors()

      Additional errors related to the API Extension.

      Returns:
      extensionErrors

    • getExtensionBody

      @Nullable public String getExtensionBody()

      The response body returned by the Extension.

      Returns:
      extensionBody

    • getExtensionStatusCode

      @Nullable public Integer getExtensionStatusCode()

      Http status code returned by the Extension.

      Returns:
      extensionStatusCode

    • getExtensionId

      public String getExtensionId()

      Unique identifier of the Extension.

      Returns:
      extensionId

    • getExtensionKey

      @Nullable public String getExtensionKey()

      User-defined unique identifier of the Extension.

      Returns:
      extensionKey

    • build

      public ExtensionBadResponseError build()
      builds ExtensionBadResponseError with checking for non-null required values
      Specified by:
      build in interface Builder<ExtensionBadResponseError>
      Returns:
      ExtensionBadResponseError

    • buildUnchecked

      public ExtensionBadResponseError buildUnchecked()
      builds ExtensionBadResponseError without checking for non-null required values
      Returns:
      ExtensionBadResponseError

    • of

      public static ExtensionBadResponseErrorBuilder of()
      factory method for an instance of ExtensionBadResponseErrorBuilder
      Returns:
      builder

    • of

      public static ExtensionBadResponseErrorBuilder of(ExtensionBadResponseError template)
      create builder for ExtensionBadResponseError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder