Package software.amazon.awssdk.services.robomaker.model

Class SimulationJob

    • Method Detail

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the simulation job.

        Returns:
        The Amazon Resource Name (ARN) of the simulation job.

      • name

        public final String name()

        The name of the simulation job.

        Returns:
        The name of the simulation job.

      • lastStartedAt

        public final Instant lastStartedAt()

        The time, in milliseconds since the epoch, when the simulation job was last started.

        Returns:
        The time, in milliseconds since the epoch, when the simulation job was last started.

      • lastUpdatedAt

        public final Instant lastUpdatedAt()

        The time, in milliseconds since the epoch, when the simulation job was last updated.

        Returns:
        The time, in milliseconds since the epoch, when the simulation job was last updated.

      • failureBehavior

        public final FailureBehavior failureBehavior()

        The failure behavior the simulation job.

        Continue

        Leaves the host running for its maximum timeout duration after a 4XX error code.

        Fail

        Stop the simulation job and terminate the instance.

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

        Returns:
        The failure behavior the simulation job.

        Continue

        Leaves the host running for its maximum timeout duration after a 4XX error code.

        Fail

        Stop the simulation job and terminate the instance.

        See Also:
        FailureBehavior

      • failureBehaviorAsString

        public final String failureBehaviorAsString()

        The failure behavior the simulation job.

        Continue

        Leaves the host running for its maximum timeout duration after a 4XX error code.

        Fail

        Stop the simulation job and terminate the instance.

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

        Returns:
        The failure behavior the simulation job.

        Continue

        Leaves the host running for its maximum timeout duration after a 4XX error code.

        Fail

        Stop the simulation job and terminate the instance.

        See Also:
        FailureBehavior

      • failureReason

        public final String failureReason()

        The reason why the simulation job failed.

        Returns:
        The reason why the simulation job failed.

      • clientRequestToken

        public final String clientRequestToken()

        A unique identifier for this SimulationJob request.

        Returns:
        A unique identifier for this SimulationJob request.

      • outputLocation

        public final OutputLocation outputLocation()

        Location for output files generated by the simulation job.

        Returns:
        Location for output files generated by the simulation job.

      • loggingConfig

        public final LoggingConfig loggingConfig()

        The logging configuration.

        Returns:
        The logging configuration.

      • maxJobDurationInSeconds

        public final Long maxJobDurationInSeconds()

        The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

        Returns:
        The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

      • simulationTimeMillis

        public final Long simulationTimeMillis()

        The simulation job execution duration in milliseconds.

        Returns:
        The simulation job execution duration in milliseconds.

      • iamRole

        public final String iamRole()

        The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

        Returns:
        The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

      • hasRobotApplications

        public final boolean hasRobotApplications()
        For responses, this returns true if the service returned a value for the RobotApplications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • robotApplications

        public final List<RobotApplicationConfig> robotApplications()

        A list of robot applications.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRobotApplications() method.

        Returns:
        A list of robot applications.

      • hasSimulationApplications

        public final boolean hasSimulationApplications()
        For responses, this returns true if the service returned a value for the SimulationApplications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • simulationApplications

        public final List<SimulationApplicationConfig> simulationApplications()

        A list of simulation applications.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSimulationApplications() method.

        Returns:
        A list of simulation applications.

      • hasDataSources

        public final boolean hasDataSources()
        For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • dataSources

        public final List<DataSource> dataSources()

        The data sources for the simulation job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataSources() method.

        Returns:
        The data sources for the simulation job.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        A map that contains tag keys and tag values that are attached to the simulation job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A map that contains tag keys and tag values that are attached to the simulation job.

      • vpcConfig

        public final VPCConfigResponse vpcConfig()

        VPC configuration information.

        Returns:
        VPC configuration information.

      • networkInterface

        public final NetworkInterface networkInterface()

        Information about a network interface.

        Returns:
        Information about a network interface.

      • compute

        public final ComputeResponse compute()

        Compute information for the simulation job

        Returns:
        Compute information for the simulation job

      • hashCode

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

      • equals

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

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