Class HarnessEndpoint

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

Representation of a harness endpoint. An endpoint is a named, stable reference to a specific version of a harness that callers invoke, allowing the underlying version to be updated without changing how the agent is invoked.

See Also:

  • Method Details

    • harnessId

      public final String harnessId()

      The ID of the harness that the endpoint belongs to.

      Returns:
      The ID of the harness that the endpoint belongs to.

    • harnessName

      public final String harnessName()

      The name of the harness that the endpoint belongs to.

      Returns:
      The name of the harness that the endpoint belongs to.

    • endpointName

      public final String endpointName()

      The name of the endpoint.

      Returns:
      The name of the endpoint.

    • arn

      public final String arn()

      The ARN of the endpoint.

      Returns:
      The ARN of the endpoint.

    • status

      public final HarnessEndpointStatus status()

      The status of the endpoint.

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

      Returns:
      The status of the endpoint.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the endpoint.

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

      Returns:
      The status of the endpoint.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the endpoint was created.

      Returns:
      The timestamp when the endpoint was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the endpoint was last updated.

      Returns:
      The timestamp when the endpoint was last updated.

    • liveVersion

      public final String liveVersion()

      The harness version that the endpoint is currently serving.

      Returns:
      The harness version that the endpoint is currently serving.

    • targetVersion

      public final String targetVersion()

      The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.

      Returns:
      The harness version that the endpoint points to. While an update is in progress, this can differ from the live version until the endpoint finishes transitioning.

    • description

      public final String description()

      The description of the endpoint.

      Returns:
      The description of the endpoint.

    • failureReason

      public final String failureReason()

      The reason the endpoint's last create or update operation failed.

      Returns:
      The reason the endpoint's last create or update operation failed.

    • toBuilder

      public HarnessEndpoint.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<HarnessEndpoint.Builder,HarnessEndpoint>
      Returns:
      a builder for type T

    • builder

      public static HarnessEndpoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HarnessEndpoint.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.