Package com.qtsurfer.api.client.model

Class InsufficientScopeError

java.lang.Object
com.qtsurfer.api.client.model.InsufficientScopeError
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class InsufficientScopeError extends Object
Error envelope of a `403` returned when the API key behind the token does not carry the scope the operation needs.

  • Field Details

  • Constructor Details

    • InsufficientScopeError

      public InsufficientScopeError()

  • Method Details

    • code

      public InsufficientScopeError code(@Nonnull InsufficientScopeError.CodeEnum code)

    • getCode

      @Nonnull public InsufficientScopeError.CodeEnum getCode()
      Machine-readable error reason.
      Returns:
      code

    • setCode

      public void setCode(@Nonnull InsufficientScopeError.CodeEnum code)

    • message

      public InsufficientScopeError message(@Nonnull String message)

    • getMessage

      @Nonnull public String getMessage()
      Human-readable description of the failure.
      Returns:
      message

    • setMessage

      public void setMessage(@Nonnull String message)

    • required

      public InsufficientScopeError required(@Nonnull String required)

    • getRequired

      @Nonnull public String getRequired()
      The scope the operation needs, as `resource:action`, in lower case.
      Returns:
      required

    • setRequired

      public void setRequired(@Nonnull String required)

    • equals

      public boolean equals(Object o)
      Return true if this InsufficientScopeError object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string