DescribeSimulationResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeSimulationResponse
extends SimSpaceWeaverResponse
implements ToCopyableBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSimulationResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSimulationResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the simulation.
`static DescribeSimulationResponse.Builder`	`builder()`
`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).
`String`	`description()` The description of the simulation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionId()` A universally unique identifier (UUID) for this simulation.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LiveSimulationState`	`liveSimulationState()` A collection of additional state information, such as domain and clock configuration.
`LoggingConfiguration`	`loggingConfiguration()` Settings that control how SimSpace Weaver handles your simulation log data.
`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).
`String`	`name()` The name of the simulation.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions.
`String`	`schemaError()` Deprecated. SchemaError is no longer used, check StartError instead.
`S3Location`	`schemaS3Location()` The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSimulationResponse.Builder>`	`serializableBuilderClass()`
`S3Location`	`snapshotS3Location()` Returns the value of the SnapshotS3Location property for this object.
`String`	`startError()` An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the `STARTING` state.
`SimulationStatus`	`status()` The current lifecycle state of the simulation.
`String`	`statusAsString()` The current lifecycle state of the simulation.
`SimulationTargetStatus`	`targetStatus()` The desired lifecycle state of the simulation.
`String`	`targetStatusAsString()` The desired lifecycle state of the simulation.
`DescribeSimulationResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.simspaceweaver.model.SimSpaceWeaverResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    SimulationStatus
  - 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:
    
    SimulationStatus
  - 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:
    
    SimulationTargetStatus
  - 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:
    
    SimulationTargetStatus
  - toBuilder
```
public DescribeSimulationResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeSimulationResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.simspaceweaver.model.SimSpaceWeaverResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

creationTime

description

executionId

liveSimulationState

loggingConfiguration

maximumDuration

name

roleArn

schemaError

schemaS3Location

snapshotS3Location

startError

status

statusAsString

targetStatus

targetStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields