software.amazon.awssdk.services.bedrockagent.model.AgentAlias Maven / Gradle / Ivy
Show all versions of bedrockagent Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.bedrockagent.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details about an alias of an agent.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AgentAlias implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField AGENT_ALIAS_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentAliasArn").getter(getter(AgentAlias::agentAliasArn)).setter(setter(Builder::agentAliasArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentAliasArn").build()).build();
private static final SdkField> AGENT_ALIAS_HISTORY_EVENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("agentAliasHistoryEvents")
.getter(getter(AgentAlias::agentAliasHistoryEvents))
.setter(setter(Builder::agentAliasHistoryEvents))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentAliasHistoryEvents").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AgentAliasHistoryEvent::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField AGENT_ALIAS_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentAliasId").getter(getter(AgentAlias::agentAliasId)).setter(setter(Builder::agentAliasId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentAliasId").build()).build();
private static final SdkField AGENT_ALIAS_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentAliasName").getter(getter(AgentAlias::agentAliasName)).setter(setter(Builder::agentAliasName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentAliasName").build()).build();
private static final SdkField AGENT_ALIAS_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentAliasStatus").getter(getter(AgentAlias::agentAliasStatusAsString))
.setter(setter(Builder::agentAliasStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentAliasStatus").build()).build();
private static final SdkField AGENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("agentId").getter(getter(AgentAlias::agentId)).setter(setter(Builder::agentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("agentId").build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("clientToken").getter(getter(AgentAlias::clientToken)).setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build()).build();
private static final SdkField CREATED_AT_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("createdAt")
.getter(getter(AgentAlias::createdAt))
.setter(setter(Builder::createdAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createdAt").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(AgentAlias::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField> ROUTING_CONFIGURATION_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("routingConfiguration")
.getter(getter(AgentAlias::routingConfiguration))
.setter(setter(Builder::routingConfiguration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("routingConfiguration").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(AgentAliasRoutingConfigurationListItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField UPDATED_AT_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("updatedAt")
.getter(getter(AgentAlias::updatedAt))
.setter(setter(Builder::updatedAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updatedAt").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AGENT_ALIAS_ARN_FIELD,
AGENT_ALIAS_HISTORY_EVENTS_FIELD, AGENT_ALIAS_ID_FIELD, AGENT_ALIAS_NAME_FIELD, AGENT_ALIAS_STATUS_FIELD,
AGENT_ID_FIELD, CLIENT_TOKEN_FIELD, CREATED_AT_FIELD, DESCRIPTION_FIELD, ROUTING_CONFIGURATION_FIELD,
UPDATED_AT_FIELD));
private static final long serialVersionUID = 1L;
private final String agentAliasArn;
private final List agentAliasHistoryEvents;
private final String agentAliasId;
private final String agentAliasName;
private final String agentAliasStatus;
private final String agentId;
private final String clientToken;
private final Instant createdAt;
private final String description;
private final List routingConfiguration;
private final Instant updatedAt;
private AgentAlias(BuilderImpl builder) {
this.agentAliasArn = builder.agentAliasArn;
this.agentAliasHistoryEvents = builder.agentAliasHistoryEvents;
this.agentAliasId = builder.agentAliasId;
this.agentAliasName = builder.agentAliasName;
this.agentAliasStatus = builder.agentAliasStatus;
this.agentId = builder.agentId;
this.clientToken = builder.clientToken;
this.createdAt = builder.createdAt;
this.description = builder.description;
this.routingConfiguration = builder.routingConfiguration;
this.updatedAt = builder.updatedAt;
}
/**
*
* The Amazon Resource Name (ARN) of the alias of the agent.
*
*
* @return The Amazon Resource Name (ARN) of the alias of the agent.
*/
public final String agentAliasArn() {
return agentAliasArn;
}
/**
* For responses, this returns true if the service returned a value for the AgentAliasHistoryEvents property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasAgentAliasHistoryEvents() {
return agentAliasHistoryEvents != null && !(agentAliasHistoryEvents instanceof SdkAutoConstructList);
}
/**
*
* Contains details about the history of the alias.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasAgentAliasHistoryEvents} method.
*
*
* @return Contains details about the history of the alias.
*/
public final List agentAliasHistoryEvents() {
return agentAliasHistoryEvents;
}
/**
*
* The unique identifier of the alias of the agent.
*
*
* @return The unique identifier of the alias of the agent.
*/
public final String agentAliasId() {
return agentAliasId;
}
/**
*
* The name of the alias of the agent.
*
*
* @return The name of the alias of the agent.
*/
public final String agentAliasName() {
return agentAliasName;
}
/**
*
* The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
*
*
* -
*
* CREATING – The agent alias is being created.
*
*
* -
*
* PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
*
*
* -
*
* FAILED – The agent alias API operation failed.
*
*
* -
*
* UPDATING – The agent alias is being updated.
*
*
* -
*
* DELETING – The agent alias is being deleted.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #agentAliasStatus}
* will return {@link AgentAliasStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #agentAliasStatusAsString}.
*
*
* @return The status of the alias of the agent and whether it is ready for use. The following statuses are
* possible:
*
* -
*
* CREATING – The agent alias is being created.
*
*
* -
*
* PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
*
*
* -
*
* FAILED – The agent alias API operation failed.
*
*
* -
*
* UPDATING – The agent alias is being updated.
*
*
* -
*
* DELETING – The agent alias is being deleted.
*
*
* @see AgentAliasStatus
*/
public final AgentAliasStatus agentAliasStatus() {
return AgentAliasStatus.fromValue(agentAliasStatus);
}
/**
*
* The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
*
*
* -
*
* CREATING – The agent alias is being created.
*
*
* -
*
* PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
*
*
* -
*
* FAILED – The agent alias API operation failed.
*
*
* -
*
* UPDATING – The agent alias is being updated.
*
*
* -
*
* DELETING – The agent alias is being deleted.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #agentAliasStatus}
* will return {@link AgentAliasStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #agentAliasStatusAsString}.
*
*
* @return The status of the alias of the agent and whether it is ready for use. The following statuses are
* possible:
*
* -
*
* CREATING – The agent alias is being created.
*
*
* -
*
* PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
*
*
* -
*
* FAILED – The agent alias API operation failed.
*
*
* -
*
* UPDATING – The agent alias is being updated.
*
*
* -
*
* DELETING – The agent alias is being deleted.
*
*
* @see AgentAliasStatus
*/
public final String agentAliasStatusAsString() {
return agentAliasStatus;
}
/**
*
* The unique identifier of the agent.
*
*
* @return The unique identifier of the agent.
*/
public final String agentId() {
return agentId;
}
/**
*
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token
* matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more
* information, see Ensuring
* idempotency.
*
*
* @return A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If
* this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
* For more information, see Ensuring
* idempotency.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* The time at which the alias of the agent was created.
*
*
* @return The time at which the alias of the agent was created.
*/
public final Instant createdAt() {
return createdAt;
}
/**
*
* The description of the alias of the agent.
*
*
* @return The description of the alias of the agent.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the RoutingConfiguration property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasRoutingConfiguration() {
return routingConfiguration != null && !(routingConfiguration instanceof SdkAutoConstructList);
}
/**
*
* Contains details about the routing configuration of the alias.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasRoutingConfiguration} method.
*
*
* @return Contains details about the routing configuration of the alias.
*/
public final List routingConfiguration() {
return routingConfiguration;
}
/**
*
* The time at which the alias was last updated.
*
*
* @return The time at which the alias was last updated.
*/
public final Instant updatedAt() {
return updatedAt;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(agentAliasArn());
hashCode = 31 * hashCode + Objects.hashCode(hasAgentAliasHistoryEvents() ? agentAliasHistoryEvents() : null);
hashCode = 31 * hashCode + Objects.hashCode(agentAliasId());
hashCode = 31 * hashCode + Objects.hashCode(agentAliasName());
hashCode = 31 * hashCode + Objects.hashCode(agentAliasStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(agentId());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(createdAt());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasRoutingConfiguration() ? routingConfiguration() : null);
hashCode = 31 * hashCode + Objects.hashCode(updatedAt());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AgentAlias)) {
return false;
}
AgentAlias other = (AgentAlias) obj;
return Objects.equals(agentAliasArn(), other.agentAliasArn())
&& hasAgentAliasHistoryEvents() == other.hasAgentAliasHistoryEvents()
&& Objects.equals(agentAliasHistoryEvents(), other.agentAliasHistoryEvents())
&& Objects.equals(agentAliasId(), other.agentAliasId())
&& Objects.equals(agentAliasName(), other.agentAliasName())
&& Objects.equals(agentAliasStatusAsString(), other.agentAliasStatusAsString())
&& Objects.equals(agentId(), other.agentId()) && Objects.equals(clientToken(), other.clientToken())
&& Objects.equals(createdAt(), other.createdAt()) && Objects.equals(description(), other.description())
&& hasRoutingConfiguration() == other.hasRoutingConfiguration()
&& Objects.equals(routingConfiguration(), other.routingConfiguration())
&& Objects.equals(updatedAt(), other.updatedAt());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("AgentAlias").add("AgentAliasArn", agentAliasArn())
.add("AgentAliasHistoryEvents", hasAgentAliasHistoryEvents() ? agentAliasHistoryEvents() : null)
.add("AgentAliasId", agentAliasId()).add("AgentAliasName", agentAliasName())
.add("AgentAliasStatus", agentAliasStatusAsString()).add("AgentId", agentId()).add("ClientToken", clientToken())
.add("CreatedAt", createdAt()).add("Description", description())
.add("RoutingConfiguration", hasRoutingConfiguration() ? routingConfiguration() : null)
.add("UpdatedAt", updatedAt()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "agentAliasArn":
return Optional.ofNullable(clazz.cast(agentAliasArn()));
case "agentAliasHistoryEvents":
return Optional.ofNullable(clazz.cast(agentAliasHistoryEvents()));
case "agentAliasId":
return Optional.ofNullable(clazz.cast(agentAliasId()));
case "agentAliasName":
return Optional.ofNullable(clazz.cast(agentAliasName()));
case "agentAliasStatus":
return Optional.ofNullable(clazz.cast(agentAliasStatusAsString()));
case "agentId":
return Optional.ofNullable(clazz.cast(agentId()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "createdAt":
return Optional.ofNullable(clazz.cast(createdAt()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "routingConfiguration":
return Optional.ofNullable(clazz.cast(routingConfiguration()));
case "updatedAt":
return Optional.ofNullable(clazz.cast(updatedAt()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function