Class Harness

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

Representation of a Harness.

See Also:

  • Method Details

    • harnessId

      public final String harnessId()

      The ID of the Harness.

      Returns:
      The ID of the Harness.

    • harnessName

      public final String harnessName()

      The name of the Harness.

      Returns:
      The name of the Harness.

    • arn

      public final String arn()

      The ARN of the Harness.

      Returns:
      The ARN of the Harness.

    • status

      public final HarnessStatus status()

      The status of the Harness.

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

      Returns:
      The status of the Harness.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Harness.

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

      Returns:
      The status of the Harness.
      See Also:

    • executionRoleArn

      public final String executionRoleArn()

      IAM role the Harness assumes when running.

      Returns:
      IAM role the Harness assumes when running.

    • createdAt

      public final Instant createdAt()

      The createdAt time of the Harness.

      Returns:
      The createdAt time of the Harness.

    • updatedAt

      public final Instant updatedAt()

      The updatedAt time of the Harness.

      Returns:
      The updatedAt time of the Harness.

    • model

      public final HarnessModelConfiguration model()

      The configuration of the default model used by the Harness.

      Returns:
      The configuration of the default model used by the Harness.

    • hasSystemPrompt

      public final boolean hasSystemPrompt()
      For responses, this returns true if the service returned a value for the SystemPrompt property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • systemPrompt

      public final List<HarnessSystemContentBlock> systemPrompt()

      The system prompt of the Harness.

      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 hasSystemPrompt() method.

      Returns:
      The system prompt of the Harness.

    • hasTools

      public final boolean hasTools()
      For responses, this returns true if the service returned a value for the Tools property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • tools

      public final List<HarnessTool> tools()

      The tools of the Harness.

      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 hasTools() method.

      Returns:
      The tools of the Harness.

    • hasSkills

      public final boolean hasSkills()
      For responses, this returns true if the service returned a value for the Skills property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • skills

      public final List<HarnessSkill> skills()

      The skills of the Harness.

      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 hasSkills() method.

      Returns:
      The skills of the Harness.

    • hasAllowedTools

      public final boolean hasAllowedTools()
      For responses, this returns true if the service returned a value for the AllowedTools property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • allowedTools

      public final List<String> allowedTools()

      The allowed tools of the Harness. All tools are allowed by default.

      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 hasAllowedTools() method.

      Returns:
      The allowed tools of the Harness. All tools are allowed by default.

    • truncation

      public final HarnessTruncationConfiguration truncation()

      Configuration for truncating model context.

      Returns:
      Configuration for truncating model context.

    • environment

      public final HarnessEnvironmentProvider environment()

      The compute environment on which the Harness runs.

      Returns:
      The compute environment on which the Harness runs.

    • environmentArtifact

      public final HarnessEnvironmentArtifact environmentArtifact()

      The environment artifact (e.g., container) in which the Harness operates.

      Returns:
      The environment artifact (e.g., container) in which the Harness operates.

    • hasEnvironmentVariables

      public final boolean hasEnvironmentVariables()
      For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • environmentVariables

      public final Map<String,String> environmentVariables()

      Environment variables exposed in the environment in which the Harness operates.

      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 hasEnvironmentVariables() method.

      Returns:
      Environment variables exposed in the environment in which the Harness operates.

    • authorizerConfiguration

      public final AuthorizerConfiguration authorizerConfiguration()
      Returns the value of the AuthorizerConfiguration property for this object.
      Returns:
      The value of the AuthorizerConfiguration property for this object.

    • memory

      public final HarnessMemoryConfiguration memory()

      AgentCore Memory instance configuration for short and long term memory.

      Returns:
      AgentCore Memory instance configuration for short and long term memory.

    • maxIterations

      public final Integer maxIterations()

      The maximum number of iterations in the agent loop allowed before exiting per invocation.

      Returns:
      The maximum number of iterations in the agent loop allowed before exiting per invocation.

    • maxTokens

      public final Integer maxTokens()

      The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

      Returns:
      The maximum total number of output tokens the agent can generate across all model calls within a single invocation.

    • timeoutSeconds

      public final Integer timeoutSeconds()

      The maximum duration per invocation.

      Returns:
      The maximum duration per invocation.

    • failureReason

      public final String failureReason()

      Reason why create or update operations fail.

      Returns:
      Reason why create or update operations fail.

    • toBuilder

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

    • builder

      public static Harness.Builder builder()

    • serializableBuilderClass

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