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

Class CreateSimulationJobRequest

    • Method Detail

      • clientRequestToken

        public final String clientRequestToken()

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

        Returns:
        Unique, case-sensitive identifier that you provide to ensure the idempotency of the 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 (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

        Returns:
        The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

      • iamRole

        public final String iamRole()

        The IAM role name 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 name 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.

      • failureBehavior

        public final FailureBehavior failureBehavior()

        The failure behavior the simulation job.

        Continue

        Leaves the instance 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 instance 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 instance 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 instance running for its maximum timeout duration after a 4XX error code.

        Fail

        Stop the simulation job and terminate the instance.

        See Also:
        FailureBehavior

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

        The robot application to use in 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 hasRobotApplications() method.

        Returns:
        The robot application to use in the simulation job.

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

        The simulation application to use in 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 hasSimulationApplications() method.

        Returns:
        The simulation application to use in the simulation job.

      • 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<DataSourceConfig> dataSources()

        Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

        There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

        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:
        Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

        There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

      • 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 VPCConfig vpcConfig()

        If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

        Returns:
        If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

      • compute

        public final Compute compute()

        Compute information for the simulation job.

        Returns:
        Compute information for the simulation job.

      • 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