Class DeploymentLifecycleHookDetail

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

The details of a deployment lifecycle hook that is active during a service deployment.

You can view lifecycle hook details by calling DescribeServiceDeployments.

See Also:

  • Method Details

    • hookId

      public final String hookId()

      The ID of the lifecycle hook. Use this value when calling ContinueServiceDeployment to continue or roll back a paused deployment.

      Returns:
      The ID of the lifecycle hook. Use this value when calling ContinueServiceDeployment to continue or roll back a paused deployment.

    • targetType

      public final DeploymentLifecycleHookTargetType targetType()

      The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.

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

      Returns:
      The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.
      See Also:

    • targetTypeAsString

      public final String targetTypeAsString()

      The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.

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

      Returns:
      The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.
      See Also:

    • targetArn

      public final String targetArn()

      The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. For PAUSE hooks, this field is not set.

      Returns:
      The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. For PAUSE hooks, this field is not set.

    • status

      public final DeploymentLifecycleHookStatus status()

      The status of the lifecycle hook. Valid values depend on the hook type:

      • For AWS_LAMBDA hooks: IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

      • For PAUSE hooks: AWAITING_ACTION, SUCCEEDED, FAILED, and TIMED_OUT.

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

      Returns:
      The status of the lifecycle hook. Valid values depend on the hook type:

      • For AWS_LAMBDA hooks: IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

      • For PAUSE hooks: AWAITING_ACTION, SUCCEEDED, FAILED, and TIMED_OUT.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the lifecycle hook. Valid values depend on the hook type:

      • For AWS_LAMBDA hooks: IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

      • For PAUSE hooks: AWAITING_ACTION, SUCCEEDED, FAILED, and TIMED_OUT.

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

      Returns:
      The status of the lifecycle hook. Valid values depend on the hook type:

      • For AWS_LAMBDA hooks: IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

      • For PAUSE hooks: AWAITING_ACTION, SUCCEEDED, FAILED, and TIMED_OUT.

      See Also:

    • expiresAt

      public final Instant expiresAt()

      The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action.

      Returns:
      The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action.

    • timeoutAction

      public final DeploymentLifecycleHookAction timeoutAction()

      The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.

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

      Returns:
      The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.
      See Also:

    • timeoutActionAsString

      public final String timeoutActionAsString()

      The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.

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

      Returns:
      The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.
      See Also:

    • toBuilder

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

    • builder

      public static DeploymentLifecycleHookDetail.Builder builder()

    • serializableBuilderClass

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