software.amazon.awssdk.services.simspaceweaver.model

Interface DescribeSimulationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>, SdkBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>, SdkPojo, SdkResponse.Builder, SimSpaceWeaverResponse.Builder

Enclosing class:

DescribeSimulationResponse

public static interface DescribeSimulationResponse.Builder
extends SimSpaceWeaverResponse.Builder, SdkPojo, CopyableBuilder<DescribeSimulationResponse.Builder,DescribeSimulationResponse>

Method Summary

Modifier and Type	Method and Description
DescribeSimulationResponse.Builder	arn(String arn) The Amazon Resource Name (ARN) of the simulation.
DescribeSimulationResponse.Builder	creationTime(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).
DescribeSimulationResponse.Builder	description(String description) The description of the simulation.
DescribeSimulationResponse.Builder	executionId(String executionId) A universally unique identifier (UUID) for this simulation.
default DescribeSimulationResponse.Builder	liveSimulationState(Consumer<LiveSimulationState.Builder> liveSimulationState) A collection of additional state information, such as domain and clock configuration.
DescribeSimulationResponse.Builder	liveSimulationState(LiveSimulationState liveSimulationState) A collection of additional state information, such as domain and clock configuration.
default DescribeSimulationResponse.Builder	loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration) Settings that control how SimSpace Weaver handles your simulation log data.
DescribeSimulationResponse.Builder	loggingConfiguration(LoggingConfiguration loggingConfiguration) Settings that control how SimSpace Weaver handles your simulation log data.
DescribeSimulationResponse.Builder	maximumDuration(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).
DescribeSimulationResponse.Builder	name(String name) The name of the simulation.
DescribeSimulationResponse.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions.
DescribeSimulationResponse.Builder	schemaError(String schemaError) Deprecated. SchemaError is no longer used, check StartError instead.
default DescribeSimulationResponse.Builder	schemaS3Location(Consumer<S3Location.Builder> schemaS3Location) The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
DescribeSimulationResponse.Builder	schemaS3Location(S3Location schemaS3Location) The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
default DescribeSimulationResponse.Builder	snapshotS3Location(Consumer<S3Location.Builder> snapshotS3Location) Sets the value of the SnapshotS3Location property for this object.
DescribeSimulationResponse.Builder	snapshotS3Location(S3Location snapshotS3Location) Sets the value of the SnapshotS3Location property for this object.
DescribeSimulationResponse.Builder	startError(String startError) An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.
DescribeSimulationResponse.Builder	status(SimulationStatus status) The current lifecycle state of the simulation.
DescribeSimulationResponse.Builder	status(String status) The current lifecycle state of the simulation.
DescribeSimulationResponse.Builder	targetStatus(SimulationTargetStatus targetStatus) The desired lifecycle state of the simulation.
DescribeSimulationResponse.Builder	targetStatus(String targetStatus) The desired lifecycle state of the simulation.

Methods inherited from interface software.amazon.awssdk.services.simspaceweaver.model.SimSpaceWeaverResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

arn

DescribeSimulationResponse.Builder arn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

creationTime

DescribeSimulationResponse.Builder creationTime(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).

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

description

DescribeSimulationResponse.Builder description(String description)

The description of the simulation.

Parameters:

description - The description of the simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionId

DescribeSimulationResponse.Builder executionId(String executionId)

A universally unique identifier (UUID) for this simulation.

Parameters:

executionId - A universally unique identifier (UUID) for this simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

liveSimulationState

DescribeSimulationResponse.Builder liveSimulationState(LiveSimulationState liveSimulationState)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

liveSimulationState

default DescribeSimulationResponse.Builder liveSimulationState(Consumer<LiveSimulationState.Builder> liveSimulationState)

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

This is a convenience method that creates an instance of the LiveSimulationState.Builder avoiding the need to create one manually via LiveSimulationState.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to liveSimulationState(LiveSimulationState).

Parameters:

liveSimulationState - a consumer that will call methods on LiveSimulationState.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

liveSimulationState(LiveSimulationState)

loggingConfiguration

DescribeSimulationResponse.Builder loggingConfiguration(LoggingConfiguration loggingConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingConfiguration

default DescribeSimulationResponse.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)

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

This is a convenience method that creates an instance of the LoggingConfiguration.Builder avoiding the need to create one manually via LoggingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(LoggingConfiguration).

Parameters:

loggingConfiguration - a consumer that will call methods on LoggingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

loggingConfiguration(LoggingConfiguration)

maximumDuration

DescribeSimulationResponse.Builder maximumDuration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

name

DescribeSimulationResponse.Builder name(String name)

The name of the simulation.

Parameters:

name - The name of the simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

DescribeSimulationResponse.Builder roleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

schemaError

@Deprecated
DescribeSimulationResponse.Builder schemaError(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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

schemaS3Location

DescribeSimulationResponse.Builder schemaS3Location(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 .

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

schemaS3Location

default DescribeSimulationResponse.Builder schemaS3Location(Consumer<S3Location.Builder> 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 .

This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schemaS3Location(S3Location).

Parameters:

schemaS3Location - a consumer that will call methods on S3Location.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schemaS3Location(S3Location)

snapshotS3Location

DescribeSimulationResponse.Builder snapshotS3Location(S3Location snapshotS3Location)

Sets the value of the SnapshotS3Location property for this object.

Parameters:

snapshotS3Location - The new value for the SnapshotS3Location property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotS3Location

default DescribeSimulationResponse.Builder snapshotS3Location(Consumer<S3Location.Builder> snapshotS3Location)

Sets the value of the SnapshotS3Location property for this object. This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snapshotS3Location(S3Location).

Parameters:

snapshotS3Location - a consumer that will call methods on S3Location.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

snapshotS3Location(S3Location)

startError

DescribeSimulationResponse.Builder startError(String startError)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

DescribeSimulationResponse.Builder status(String status)

The current lifecycle state of the simulation.

Parameters:

status - The current lifecycle state of the simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SimulationStatus, SimulationStatus

status

DescribeSimulationResponse.Builder status(SimulationStatus status)

The current lifecycle state of the simulation.

Parameters:

status - The current lifecycle state of the simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SimulationStatus, SimulationStatus

targetStatus

DescribeSimulationResponse.Builder targetStatus(String targetStatus)

The desired lifecycle state of the simulation.

Parameters:

targetStatus - The desired lifecycle state of the simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SimulationTargetStatus, SimulationTargetStatus

targetStatus

DescribeSimulationResponse.Builder targetStatus(SimulationTargetStatus targetStatus)

The desired lifecycle state of the simulation.

Parameters:

targetStatus - The desired lifecycle state of the simulation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SimulationTargetStatus, SimulationTargetStatus