Class SimulationMetadata

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

A collection of data about the simulation.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Returns:
      The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • creationTime

      public final Instant creationTime()

      The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

      Returns:
      The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).

    • name

      public final String name()

      The name of the simulation.

      Returns:
      The name of the simulation.

    • status

      public final SimulationStatus status()

      The current status of the simulation.

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

      Returns:
      The current status of the simulation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the simulation.

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

      Returns:
      The current status of the simulation.
      See Also:

    • targetStatus

      public final SimulationTargetStatus targetStatus()

      The desired status of the simulation.

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

      Returns:
      The desired status of the simulation.
      See Also:

    • targetStatusAsString

      public final String targetStatusAsString()

      The desired status of the simulation.

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

      Returns:
      The desired status of the simulation.
      See Also:

    • toBuilder

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

    • builder

      public static SimulationMetadata.Builder builder()

    • serializableBuilderClass

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