Class ServiceInstanceState

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

The detailed data about the current state of this service instance.

See Also:

  • Method Details

    • hasLastSuccessfulComponentDeploymentIds

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

    • lastSuccessfulComponentDeploymentIds

      public final List<String> lastSuccessfulComponentDeploymentIds()

      The IDs for the last successful components deployed for this service instance.

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

      Returns:
      The IDs for the last successful components deployed for this service instance.

    • lastSuccessfulEnvironmentDeploymentId

      public final String lastSuccessfulEnvironmentDeploymentId()

      The ID for the last successful environment deployed for this service instance.

      Returns:
      The ID for the last successful environment deployed for this service instance.

    • lastSuccessfulServicePipelineDeploymentId

      public final String lastSuccessfulServicePipelineDeploymentId()

      The ID for the last successful service pipeline deployed for this service instance.

      Returns:
      The ID for the last successful service pipeline deployed for this service instance.

    • spec

      public final String spec()

      The service spec that was used to create the service instance.

      Returns:
      The service spec that was used to create the service instance.

    • templateMajorVersion

      public final String templateMajorVersion()

      The major version of the service template that was used to create the service pipeline.

      Returns:
      The major version of the service template that was used to create the service pipeline.

    • templateMinorVersion

      public final String templateMinorVersion()

      The minor version of the service template that was used to create the service pipeline.

      Returns:
      The minor version of the service template that was used to create the service pipeline.

    • templateName

      public final String templateName()

      The name of the service template that was used to create the service instance.

      Returns:
      The name of the service template that was used to create the service instance.

    • toBuilder

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

    • builder

      public static ServiceInstanceState.Builder builder()

    • serializableBuilderClass

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