Class Goal

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

Represents a goal with all its properties and metadata

See Also:

  • Method Details

    • agentSpaceArn

      public final String agentSpaceArn()

      The unique identifier for the agent space containing this goal

      Returns:
      The unique identifier for the agent space containing this goal

    • goalId

      public final String goalId()

      The unique identifier for this goal

      Returns:
      The unique identifier for this goal

    • title

      public final String title()

      The title of the goal

      Returns:
      The title of the goal

    • content

      public final GoalContent content()

      Content of the goal

      Returns:
      Content of the goal

    • status

      public final GoalStatus status()

      Current status of the goal itself

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

      Returns:
      Current status of the goal itself
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the goal itself

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

      Returns:
      Current status of the goal itself
      See Also:

    • goalType

      public final GoalType goalType()

      Type of goal based on its origin

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

      Returns:
      Type of goal based on its origin
      See Also:

    • goalTypeAsString

      public final String goalTypeAsString()

      Type of goal based on its origin

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

      Returns:
      Type of goal based on its origin
      See Also:

    • createdAt

      public final Instant createdAt()

      Timestamp when this goal was created

      Returns:
      Timestamp when this goal was created

    • updatedAt

      public final Instant updatedAt()

      Timestamp when this goal was last updated

      Returns:
      Timestamp when this goal was last updated

    • lastEvaluatedAt

      public final Instant lastEvaluatedAt()

      Timestamp when the goal was last evaluated

      Returns:
      Timestamp when the goal was last evaluated

    • lastTaskId

      public final String lastTaskId()

      ID of the most recent task associated with this goal

      Returns:
      ID of the most recent task associated with this goal

    • lastSuccessfulTaskId

      public final String lastSuccessfulTaskId()

      ID of the most recent successful task associated with this goal

      Returns:
      ID of the most recent successful task associated with this goal

    • version

      public final Integer version()

      Version number for optimistic locking

      Returns:
      Version number for optimistic locking

    • evaluationSchedule

      public final GoalSchedule evaluationSchedule()

      Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

      Returns:
      Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily

    • toBuilder

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

    • builder

      public static Goal.Builder builder()

    • serializableBuilderClass

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