Package software.amazon.awssdk.services.simspaceweaver.model

Interface DescribeSimulationResponse.Builder

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

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

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

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

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