com.microsoft.kiota.ResponseHandler Maven / Gradle / Ivy

Go to download
package com.microsoft.kiota;

import com.microsoft.kiota.serialization.Parsable;
import com.microsoft.kiota.serialization.ParsableFactory;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;

import java.util.HashMap;

/** Defines the contract for a response handler. */
public interface ResponseHandler {
    /**
     * Callback method that is invoked when a response is received.
     *
     * @param response             The native response object.
     * @param errorMappings        the error mappings for the response to use when deserializing failed responses bodies. Where an error code like 401 applies specifically to that status code, a class code like 4XX applies to all status codes within the range if an the specific error code is not present.
     * @param  The type of the native response object.
     * @param           The type of the response model object.
     * @return The deserialized response model object.
     */
    @Nullable  ModelType handleResponse(
            @Nonnull final NativeResponseType response,
            @Nullable final HashMap> errorMappings);
}