Class AgentEndpoint

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.AgentEndpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentEndpoint.Builder,AgentEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class AgentEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AgentEndpoint.Builder,AgentEndpoint>

Contains information about an agent runtime endpoint. An endpoint provides a way to connect to and interact with an agent runtime.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the agent runtime endpoint.

      Returns:
      The name of the agent runtime endpoint.

    • liveVersion

      public final String liveVersion()

      The live version of the agent runtime endpoint. This is the version that is currently serving requests.

      Returns:
      The live version of the agent runtime endpoint. This is the version that is currently serving requests.

    • targetVersion

      public final String targetVersion()

      The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.

      Returns:
      The target version of the agent runtime endpoint. This is the version that the endpoint is being updated to.

    • agentRuntimeEndpointArn

      public final String agentRuntimeEndpointArn()

      The Amazon Resource Name (ARN) of the agent runtime endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the agent runtime endpoint.

    • agentRuntimeArn

      public final String agentRuntimeArn()

      The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the agent runtime associated with the endpoint.

    • status

      public final AgentEndpointStatus status()

      The current status of the agent runtime endpoint.

      If the service returns an enum value that is not available in the current SDK version, status will return AgentEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the agent runtime endpoint.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the agent runtime endpoint.

      If the service returns an enum value that is not available in the current SDK version, status will return AgentEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the agent runtime endpoint.
      See Also:

    • id

      public final String id()

      The unique identifier of the agent runtime endpoint.

      Returns:
      The unique identifier of the agent runtime endpoint.

    • description

      public final String description()

      The description of the agent runtime endpoint.

      Returns:
      The description of the agent runtime endpoint.

    • createdAt

      public final Instant createdAt()

      The timestamp when the agent runtime endpoint was created.

      Returns:
      The timestamp when the agent runtime endpoint was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp when the agent runtime endpoint was last updated.

      Returns:
      The timestamp when the agent runtime endpoint was last updated.

    • toBuilder

      public AgentEndpoint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AgentEndpoint.Builder,AgentEndpoint>
      Returns:
      a builder for type T

    • builder

      public static AgentEndpoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AgentEndpoint.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.