io.github.cdklabs.generative_ai_cdk_constructs.bedrock.AgentAliasProps Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;
/**
* (experimental) Interface to create a new Agent Alias.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-23T18:35:37.384Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.generative_ai_cdk_constructs.$Module.class, fqn = "@cdklabs/generative-ai-cdk-constructs.bedrock.AgentAliasProps")
@software.amazon.jsii.Jsii.Proxy(AgentAliasProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface AgentAliasProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The unique identifier of the agent.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getAgentId();
/**
* (experimental) The version of the agent to associate with the agent alias.
*
* Default: - Creates a new version of the agent.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getAgentVersion() {
return null;
}
/**
* (experimental) The name for the agent alias.
*
* Default: - 'latest'
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getAliasName() {
return null;
}
/**
* (experimental) Description for the agent alias.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getDescription() {
return null;
}
/**
* (experimental) The list of resource update timestamps to let CloudFormation determine when to update the alias.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.util.List getResourceUpdates() {
return null;
}
/**
* (experimental) OPTIONAL: Tag (KEY-VALUE) bedrock agent resource.
*
* Default: - false
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.util.Map getTags() {
return null;
}
/**
* @return a {@link Builder} of {@link AgentAliasProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link AgentAliasProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String agentId;
java.lang.String agentVersion;
java.lang.String aliasName;
java.lang.String description;
java.util.List resourceUpdates;
java.util.Map tags;
/**
* Sets the value of {@link AgentAliasProps#getAgentId}
* @param agentId The unique identifier of the agent. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder agentId(java.lang.String agentId) {
this.agentId = agentId;
return this;
}
/**
* Sets the value of {@link AgentAliasProps#getAgentVersion}
* @param agentVersion The version of the agent to associate with the agent alias.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder agentVersion(java.lang.String agentVersion) {
this.agentVersion = agentVersion;
return this;
}
/**
* Sets the value of {@link AgentAliasProps#getAliasName}
* @param aliasName The name for the agent alias.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder aliasName(java.lang.String aliasName) {
this.aliasName = aliasName;
return this;
}
/**
* Sets the value of {@link AgentAliasProps#getDescription}
* @param description Description for the agent alias.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link AgentAliasProps#getResourceUpdates}
* @param resourceUpdates The list of resource update timestamps to let CloudFormation determine when to update the alias.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder resourceUpdates(java.util.List resourceUpdates) {
this.resourceUpdates = resourceUpdates;
return this;
}
/**
* Sets the value of {@link AgentAliasProps#getTags}
* @param tags OPTIONAL: Tag (KEY-VALUE) bedrock agent resource.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder tags(java.util.Map tags) {
this.tags = tags;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link AgentAliasProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public AgentAliasProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link AgentAliasProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AgentAliasProps {
private final java.lang.String agentId;
private final java.lang.String agentVersion;
private final java.lang.String aliasName;
private final java.lang.String description;
private final java.util.List resourceUpdates;
private final java.util.Map tags;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.agentId = software.amazon.jsii.Kernel.get(this, "agentId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.agentVersion = software.amazon.jsii.Kernel.get(this, "agentVersion", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.aliasName = software.amazon.jsii.Kernel.get(this, "aliasName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.resourceUpdates = software.amazon.jsii.Kernel.get(this, "resourceUpdates", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.tags = software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.mapOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.agentId = java.util.Objects.requireNonNull(builder.agentId, "agentId is required");
this.agentVersion = builder.agentVersion;
this.aliasName = builder.aliasName;
this.description = builder.description;
this.resourceUpdates = builder.resourceUpdates;
this.tags = builder.tags;
}
@Override
public final java.lang.String getAgentId() {
return this.agentId;
}
@Override
public final java.lang.String getAgentVersion() {
return this.agentVersion;
}
@Override
public final java.lang.String getAliasName() {
return this.aliasName;
}
@Override
public final java.lang.String getDescription() {
return this.description;
}
@Override
public final java.util.List getResourceUpdates() {
return this.resourceUpdates;
}
@Override
public final java.util.Map getTags() {
return this.tags;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("agentId", om.valueToTree(this.getAgentId()));
if (this.getAgentVersion() != null) {
data.set("agentVersion", om.valueToTree(this.getAgentVersion()));
}
if (this.getAliasName() != null) {
data.set("aliasName", om.valueToTree(this.getAliasName()));
}
if (this.getDescription() != null) {
data.set("description", om.valueToTree(this.getDescription()));
}
if (this.getResourceUpdates() != null) {
data.set("resourceUpdates", om.valueToTree(this.getResourceUpdates()));
}
if (this.getTags() != null) {
data.set("tags", om.valueToTree(this.getTags()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@cdklabs/generative-ai-cdk-constructs.bedrock.AgentAliasProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
AgentAliasProps.Jsii$Proxy that = (AgentAliasProps.Jsii$Proxy) o;
if (!agentId.equals(that.agentId)) return false;
if (this.agentVersion != null ? !this.agentVersion.equals(that.agentVersion) : that.agentVersion != null) return false;
if (this.aliasName != null ? !this.aliasName.equals(that.aliasName) : that.aliasName != null) return false;
if (this.description != null ? !this.description.equals(that.description) : that.description != null) return false;
if (this.resourceUpdates != null ? !this.resourceUpdates.equals(that.resourceUpdates) : that.resourceUpdates != null) return false;
return this.tags != null ? this.tags.equals(that.tags) : that.tags == null;
}
@Override
public final int hashCode() {
int result = this.agentId.hashCode();
result = 31 * result + (this.agentVersion != null ? this.agentVersion.hashCode() : 0);
result = 31 * result + (this.aliasName != null ? this.aliasName.hashCode() : 0);
result = 31 * result + (this.description != null ? this.description.hashCode() : 0);
result = 31 * result + (this.resourceUpdates != null ? this.resourceUpdates.hashCode() : 0);
result = 31 * result + (this.tags != null ? this.tags.hashCode() : 0);
return result;
}
}
}