Class DeploymentEvent

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

An object that describes a deployment event.

See Also:

  • Method Details

    • eventType

      public final DeploymentEventType eventType()

      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.

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

      Returns:
      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.
      See Also:

    • eventTypeAsString

      public final String eventTypeAsString()

      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.

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

      Returns:
      The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.
      See Also:

    • triggeredBy

      public final TriggeredBy triggeredBy()

      The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

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

      Returns:
      The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
      See Also:

    • triggeredByAsString

      public final String triggeredByAsString()

      The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

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

      Returns:
      The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
      See Also:

    • description

      public final String description()

      A description of the deployment event. Descriptions include, but are not limited to, the following:

      • The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.

      • The percentage of hosts that received the deployment.

      • A recommendation to attempt a new deployment (in the case of an internal error).

      Returns:
      A description of the deployment event. Descriptions include, but are not limited to, the following:

      • The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.

      • The percentage of hosts that received the deployment.

      • A recommendation to attempt a new deployment (in the case of an internal error).

    • hasActionInvocations

      public final boolean hasActionInvocations()
      For responses, this returns true if the service returned a value for the ActionInvocations 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.

    • actionInvocations

      public final List<ActionInvocation> actionInvocations()

      The list of extensions that were invoked as part of the deployment.

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

      Returns:
      The list of extensions that were invoked as part of the deployment.

    • occurredAt

      public final Instant occurredAt()

      The date and time the event occurred.

      Returns:
      The date and time the event occurred.

    • toBuilder

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

    • builder

      public static DeploymentEvent.Builder builder()

    • serializableBuilderClass

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