Package org.openapitools.client.auth

Class ApiKeyAuth

java.lang.Object

org.openapitools.client.auth.ApiKeyAuth

All Implemented Interfaces:

Authentication

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-22T02:16:26.710079594Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class ApiKeyAuth
extends Object
implements Authentication

Field Summary

Fields

Modifier and Type	Field	Description
private String	apiKey
private String	apiKeyPrefix
private final String	location
private final String	paramName

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuth(String location, String paramName)

Method Summary

Modifier and Type	Method	Description
void	applyToParams(List<Pair> queryParams, Map<String,String> headerParams, Map<String,String> cookieParams, String payload, String method, URI uri)	Apply authentication settings to header and query params.
String	getApiKey()
String	getApiKeyPrefix()
String	getLocation()
String	getParamName()
void	setApiKey(String apiKey)
void	setApiKeyPrefix(String apiKeyPrefix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

location

private final String location

paramName

private final String paramName

apiKey

private String apiKey

apiKeyPrefix

private String apiKeyPrefix

Constructor Details

ApiKeyAuth

public ApiKeyAuth(String location,
 String paramName)

Method Details

getLocation

public String getLocation()

getParamName

public String getParamName()

getApiKey

public String getApiKey()

setApiKey

public void setApiKey(String apiKey)

getApiKeyPrefix

public String getApiKeyPrefix()

setApiKeyPrefix

public void setApiKeyPrefix(String apiKeyPrefix)

applyToParams

public void applyToParams(List<Pair> queryParams,
 Map<String,String> headerParams,
 Map<String,String> cookieParams,
 String payload,
 String method,
 URI uri)
                   throws ApiException

Description copied from interface: Authentication

Apply authentication settings to header and query params.

Specified by:

applyToParams in interface Authentication

Parameters:

queryParams - List of query parameters

headerParams - Map of header parameters

cookieParams - Map of cookie parameters

payload - HTTP request body

method - HTTP method

uri - URI

Throws:

ApiException - if failed to update the parameters