Package org.a2aproject.sdk.spec

Class APIKeySecurityScheme.Builder

java.lang.Object

org.a2aproject.sdk.spec.APIKeySecurityScheme.Builder

Enclosing class:

APIKeySecurityScheme

public static class APIKeySecurityScheme.Builder
extends Object

Builder for constructing immutable APIKeySecurityScheme instances.

Example usage:

 APIKeySecurityScheme scheme = APIKeySecurityScheme.builder()
     .location(Location.HEADER)
     .name("X-API-Key")
     .description("API key authentication")
     .build();
 

Method Summary

Modifier and Type	Method	Description
APIKeySecurityScheme	build()	Builds a new immutable APIKeySecurityScheme from the current builder state.
APIKeySecurityScheme.Builder	description(String description)	Sets the human-readable description of the security scheme.
APIKeySecurityScheme.Builder	location(APIKeySecurityScheme.Location location)	Sets the location where the API key should be sent.
APIKeySecurityScheme.Builder	name(String name)	Sets the name of the API key parameter.

Methods inherited from class java.lang.Object

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

Method Details

location

public APIKeySecurityScheme.Builder location(APIKeySecurityScheme.Location location)

Sets the location where the API key should be sent.

Parameters:

location - the API key location (header, query, or cookie) (required)

Returns:

this builder for method chaining

name

public APIKeySecurityScheme.Builder name(String name)

Sets the name of the API key parameter.

Parameters:

name - the parameter name (required)

Returns:

this builder for method chaining

description

public APIKeySecurityScheme.Builder description(String description)

Sets the human-readable description of the security scheme.

Parameters:

description - the description (optional)

Returns:

this builder for method chaining

build

public APIKeySecurityScheme build()

Builds a new immutable APIKeySecurityScheme from the current builder state.

Returns:

a new APIKeySecurityScheme instance

Throws:

IllegalArgumentException - if location or name is null