Class ComponentSummary

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

Summary data of an Proton component resource.

For more information about components, see Proton components in the Proton User Guide.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the component.

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

    • createdAt

      public final Instant createdAt()

      The time when the component was created.

      Returns:
      The time when the component was created.

    • deploymentStatus

      public final DeploymentStatus deploymentStatus()

      The component deployment status.

      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 component deployment status.
      See Also:

    • deploymentStatusAsString

      public final String deploymentStatusAsString()

      The component deployment status.

      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 component deployment status.
      See Also:

    • deploymentStatusMessage

      public final String deploymentStatusMessage()

      The message associated with the component deployment status.

      Returns:
      The message associated with the component deployment status.

    • environmentName

      public final String environmentName()

      The name of the Proton environment that this component is associated with.

      Returns:
      The name of the Proton environment that this component is associated with.

    • lastAttemptedDeploymentId

      public final String lastAttemptedDeploymentId()

      The ID of the last attempted deployment of this component.

      Returns:
      The ID of the last attempted deployment of this component.

    • lastDeploymentAttemptedAt

      public final Instant lastDeploymentAttemptedAt()

      The time when a deployment of the component was last attempted.

      Returns:
      The time when a deployment of the component was last attempted.

    • lastDeploymentSucceededAt

      public final Instant lastDeploymentSucceededAt()

      The time when the component was last deployed successfully.

      Returns:
      The time when the component was last deployed successfully.

    • lastModifiedAt

      public final Instant lastModifiedAt()

      The time when the component was last modified.

      Returns:
      The time when the component was last modified.

    • lastSucceededDeploymentId

      public final String lastSucceededDeploymentId()

      The ID of the last successful deployment of this component.

      Returns:
      The ID of the last successful deployment of this component.

    • name

      public final String name()

      The name of the component.

      Returns:
      The name of the component.

    • serviceInstanceName

      public final String serviceInstanceName()

      The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

      Returns:
      The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

    • serviceName

      public final String serviceName()

      The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

      Returns:
      The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

    • toBuilder

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

    • builder

      public static ComponentSummary.Builder builder()

    • serializableBuilderClass

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