Class AgentResponsesAuthErrorBuilder

java.lang.Object
com.commercetools.api.models.agent.AgentResponsesAuthErrorBuilder
All Implemented Interfaces:
Builder<AgentResponsesAuthError>

public class AgentResponsesAuthErrorBuilder extends Object implements Builder<AgentResponsesAuthError>
AgentResponsesAuthErrorBuilder
Example to create an instance using the builder pattern

     AgentResponsesAuthError agentResponsesAuthError = AgentResponsesAuthError.builder()
             .statusCode(1)
             .message("{message}")
             .plusErrors(errorsBuilder -> errorsBuilder)
             .error("{error}")
             .build()
 
  • Constructor Details

    • AgentResponsesAuthErrorBuilder

      public AgentResponsesAuthErrorBuilder()
  • Method Details

    • statusCode

      public AgentResponsesAuthErrorBuilder statusCode(Integer statusCode)

      HTTP status code corresponding to the error.

      Parameters:
      statusCode - value to be set
      Returns:
      Builder
    • message

      public AgentResponsesAuthErrorBuilder message(String message)

      First error message in the errors array.

      Parameters:
      message - value to be set
      Returns:
      Builder
    • errors

      public AgentResponsesAuthErrorBuilder errors(ErrorObject... errors)

      Authentication and authorization-related errors returned for a request.

      Parameters:
      errors - value to be set
      Returns:
      Builder
    • errors

      Authentication and authorization-related errors returned for a request.

      Parameters:
      errors - value to be set
      Returns:
      Builder
    • plusErrors

      public AgentResponsesAuthErrorBuilder plusErrors(ErrorObject... errors)

      Authentication and authorization-related errors returned for a request.

      Parameters:
      errors - value to be set
      Returns:
      Builder
    • plusErrors

      Authentication and authorization-related errors returned for a request.

      Parameters:
      builder - function to build the errors value
      Returns:
      Builder
    • withErrors

      Authentication and authorization-related errors returned for a request.

      Parameters:
      builder - function to build the errors value
      Returns:
      Builder
    • error

      public AgentResponsesAuthErrorBuilder error(String error)

      Error code as per the OAuth 2.0 specification. For example: "access_denied".

      Parameters:
      error - value to be set
      Returns:
      Builder
    • error_description

      public AgentResponsesAuthErrorBuilder error_description(@Nullable String error_description)

      Plain text description of the first error.

      Parameters:
      error_description - value to be set
      Returns:
      Builder
    • getStatusCode

      public Integer getStatusCode()

      HTTP status code corresponding to the error.

      Returns:
      statusCode
    • getMessage

      public String getMessage()

      First error message in the errors array.

      Returns:
      message
    • getErrors

      public List<ErrorObject> getErrors()

      Authentication and authorization-related errors returned for a request.

      Returns:
      errors
    • getError

      public String getError()

      Error code as per the OAuth 2.0 specification. For example: "access_denied".

      Returns:
      error
    • getError_description

      @Nullable public String getError_description()

      Plain text description of the first error.

      Returns:
      error_description
    • build

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

      public AgentResponsesAuthError buildUnchecked()
      builds AgentResponsesAuthError without checking for non-null required values
      Returns:
      AgentResponsesAuthError
    • of

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

      create builder for AgentResponsesAuthError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder