Class DescribeSimulationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.simspaceweaver.model.SimSpaceWeaverResponse
software.amazon.awssdk.services.simspaceweaver.model.DescribeSimulationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeSimulationResponse extends SimSpaceWeaverResponse implements ToCopyableBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>

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

    • description

      public final String description()

      The description of the simulation.

      Returns:
      The description of the simulation.

    • executionId

      public final String executionId()

      A universally unique identifier (UUID) for this simulation.

      Returns:
      A universally unique identifier (UUID) for this simulation.

    • liveSimulationState

      public final LiveSimulationState liveSimulationState()

      A collection of additional state information, such as domain and clock configuration.

      Returns:
      A collection of additional state information, such as domain and clock configuration.

    • loggingConfiguration

      public final LoggingConfiguration loggingConfiguration()

      Settings that control how SimSpace Weaver handles your simulation log data.

      Returns:
      Settings that control how SimSpace Weaver handles your simulation log data.

    • maximumDuration

      public final String maximumDuration()

      The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.

      Returns:
      The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.

    • name

      public final String name()

      The name of the simulation.

      Returns:
      The name of the simulation.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.

    • schemaError

      @Deprecated public final String schemaError()
      Deprecated.
      SchemaError is no longer used, check StartError instead.

      An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.

      Returns:
      An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.

    • schemaS3Location

      public final S3Location schemaS3Location()

      The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Returns:
      The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

    • snapshotS3Location

      public final S3Location snapshotS3Location()
      Returns the value of the SnapshotS3Location property for this object.
      Returns:
      The value of the SnapshotS3Location property for this object.

    • startError

      public final String startError()

      An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

      Returns:
      An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.

    • status

      public final SimulationStatus status()

      The current lifecycle state 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 lifecycle state of the simulation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle state 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 lifecycle state of the simulation.
      See Also:

    • targetStatus

      public final SimulationTargetStatus targetStatus()

      The desired lifecycle state 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 lifecycle state of the simulation.
      See Also:

    • targetStatusAsString

      public final String targetStatusAsString()

      The desired lifecycle state 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 lifecycle state of the simulation.
      See Also:

    • toBuilder

      public DescribeSimulationResponse.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<DescribeSimulationResponse.Builder,DescribeSimulationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeSimulationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeSimulationResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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