Class Deployment

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

Describes a deployment of a stack or app.

See Also:

  • Method Details

    • deploymentId

      public final String deploymentId()

      The deployment ID.

      Returns:
      The deployment ID.

    • stackId

      public final String stackId()

      The stack ID.

      Returns:
      The stack ID.

    • appId

      public final String appId()

      The app ID.

      Returns:
      The app ID.

    • createdAt

      public final String createdAt()

      Date when the deployment was created.

      Returns:
      Date when the deployment was created.

    • completedAt

      public final String completedAt()

      Date when the deployment completed.

      Returns:
      Date when the deployment completed.

    • duration

      public final Integer duration()

      The deployment duration.

      Returns:
      The deployment duration.

    • iamUserArn

      public final String iamUserArn()

      The user's IAM ARN.

      Returns:
      The user's IAM ARN.

    • comment

      public final String comment()

      A user-defined comment.

      Returns:
      A user-defined comment.

    • command

      public final DeploymentCommand command()

      Used to specify a stack or deployment command.

      Returns:
      Used to specify a stack or deployment command.

    • status

      public final String status()

      The deployment status:

      • running

      • successful

      • failed

      Returns:
      The deployment status:

      • running

      • successful

      • failed

    • customJson

      public final String customJson()

      A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

      Returns:
      A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

      "{\"key1\": \"value1\", \"key2\": \"value2\",...}"

      For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

    • hasInstanceIds

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

    • instanceIds

      public final List<String> instanceIds()

      The IDs of the target instances.

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

      Returns:
      The IDs of the target instances.

    • toBuilder

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

    • builder

      public static Deployment.Builder builder()

    • serializableBuilderClass

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