Package com.google.genkit.ai.agent

Class AgentMetadata

java.lang.Object

com.google.genkit.ai.agent.AgentMetadata

public class AgentMetadata
extends Object

AgentMetadata describes the capabilities and configuration of an agent endpoint.

stateManagement is the string "server" or "client".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AgentMetadata.Builder	Builder for AgentMetadata.

Constructor Summary

Constructors

Constructor	Description
AgentMetadata()	Default constructor.

Method Summary

Modifier and Type	Method	Description
static AgentMetadata.Builder	builder()	Creates a builder for AgentMetadata.
String	getStateManagement()	Returns the state management mode.
Map<String,Object>	getStateSchema()	Returns the JSON schema for the agent state, if provided.
boolean	isAbortable()	Returns whether the agent supports abort.
void	setAbortable(boolean abortable)	Sets whether the agent supports abort.
void	setStateManagement(String stateManagement)	Sets the state management mode.
void	setStateSchema(Map<String,Object> stateSchema)	Sets the JSON schema for the agent state.

Methods inherited from class java.lang.Object

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

Constructor Details

AgentMetadata

public AgentMetadata()

Default constructor.

Method Details

builder

public static AgentMetadata.Builder builder()

Creates a builder for AgentMetadata.

Returns:

a new builder

getStateManagement

public String getStateManagement()

Returns the state management mode.

Returns:

"server" or "client"

setStateManagement

public void setStateManagement(String stateManagement)

Sets the state management mode.

Parameters:

stateManagement - "server" or "client"

isAbortable

public boolean isAbortable()

Returns whether the agent supports abort.

Returns:

true if abortable

setAbortable

public void setAbortable(boolean abortable)

Sets whether the agent supports abort.

Parameters:

abortable - true if abortable

getStateSchema

public Map<String,Object> getStateSchema()

Returns the JSON schema for the agent state, if provided.

Returns:

the state schema, or null if not set

setStateSchema

public void setStateSchema(Map<String,Object> stateSchema)

Sets the JSON schema for the agent state.

Parameters:

stateSchema - the state schema