Class Deployment

java.lang.Object
software.amazon.awssdk.services.proton.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>

The detailed information about a deployment.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the deployment.

      Returns:
      The Amazon Resource Name (ARN) of the deployment.

    • completedAt

      public final Instant completedAt()

      The date and time the deployment was completed.

      Returns:
      The date and time the deployment was completed.

    • componentName

      public final String componentName()

      The name of the component associated with this deployment.

      Returns:
      The name of the component associated with this deployment.

    • createdAt

      public final Instant createdAt()

      The date and time the deployment was created.

      Returns:
      The date and time the deployment was created.

    • deploymentStatus

      public final DeploymentStatus deploymentStatus()

      The status of the deployment.

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

      Returns:
      The status of the deployment.
      See Also:

    • deploymentStatusAsString

      public final String deploymentStatusAsString()

      The status of the deployment.

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

      Returns:
      The status of the deployment.
      See Also:

    • deploymentStatusMessage

      public final String deploymentStatusMessage()

      The deployment status message.

      Returns:
      The deployment status message.

    • environmentName

      public final String environmentName()

      The name of the environment associated with this deployment.

      Returns:
      The name of the environment associated with this deployment.

    • id

      public final String id()

      The ID of the deployment.

      Returns:
      The ID of the deployment.

    • initialState

      public final DeploymentState initialState()

      The initial state of the target resource at the time of the deployment.

      Returns:
      The initial state of the target resource at the time of the deployment.

    • lastAttemptedDeploymentId

      public final String lastAttemptedDeploymentId()

      The ID of the last attempted deployment.

      Returns:
      The ID of the last attempted deployment.

    • lastModifiedAt

      public final Instant lastModifiedAt()

      The date and time the deployment was last modified.

      Returns:
      The date and time the deployment was last modified.

    • lastSucceededDeploymentId

      public final String lastSucceededDeploymentId()

      The ID of the last successful deployment.

      Returns:
      The ID of the last successful deployment.

    • serviceInstanceName

      public final String serviceInstanceName()

      The name of the deployment's service instance.

      Returns:
      The name of the deployment's service instance.

    • serviceName

      public final String serviceName()

      The name of the service in this deployment.

      Returns:
      The name of the service in this deployment.

    • targetArn

      public final String targetArn()

      The Amazon Resource Name (ARN) of the target of the deployment.

      Returns:
      The Amazon Resource Name (ARN) of the target of the deployment.

    • targetResourceCreatedAt

      public final Instant targetResourceCreatedAt()

      The date and time the depoyment target was created.

      Returns:
      The date and time the depoyment target was created.

    • targetResourceType

      public final DeploymentTargetResourceType targetResourceType()

      The resource type of the deployment target. It can be an environment, service, service instance, or component.

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

      Returns:
      The resource type of the deployment target. It can be an environment, service, service instance, or component.
      See Also:

    • targetResourceTypeAsString

      public final String targetResourceTypeAsString()

      The resource type of the deployment target. It can be an environment, service, service instance, or component.

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

      Returns:
      The resource type of the deployment target. It can be an environment, service, service instance, or component.
      See Also:

    • targetState

      public final DeploymentState targetState()

      The target state of the target resource at the time of the deployment.

      Returns:
      The target state of the target resource at the time of the deployment.

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.