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

Interface CreateSimulationJobRequest.Builder

    • Method Detail

      • clientRequestToken

        CreateSimulationJobRequest.Builder clientRequestToken​(String clientRequestToken)

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

        Parameters:
        clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputLocation

        CreateSimulationJobRequest.Builder outputLocation​(OutputLocation outputLocation)

        Location for output files generated by the simulation job.

        Parameters:
        outputLocation - Location for output files generated by the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • loggingConfig

        CreateSimulationJobRequest.Builder loggingConfig​(LoggingConfig loggingConfig)

        The logging configuration.

        Parameters:
        loggingConfig - The logging configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxJobDurationInSeconds

        CreateSimulationJobRequest.Builder maxJobDurationInSeconds​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • iamRole

        CreateSimulationJobRequest.Builder iamRole​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • failureBehavior

        CreateSimulationJobRequest.Builder failureBehavior​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FailureBehavior, FailureBehavior

      • failureBehavior

        CreateSimulationJobRequest.Builder failureBehavior​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FailureBehavior, FailureBehavior

      • robotApplications

        CreateSimulationJobRequest.Builder robotApplications​(Collection<RobotApplicationConfig> robotApplications)

        The robot application to use in the simulation job.

        Parameters:
        robotApplications - The robot application to use in the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • robotApplications

        CreateSimulationJobRequest.Builder robotApplications​(RobotApplicationConfig... robotApplications)

        The robot application to use in the simulation job.

        Parameters:
        robotApplications - The robot application to use in the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • simulationApplications

        CreateSimulationJobRequest.Builder simulationApplications​(Collection<SimulationApplicationConfig> simulationApplications)

        The simulation application to use in the simulation job.

        Parameters:
        simulationApplications - The simulation application to use in the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • simulationApplications

        CreateSimulationJobRequest.Builder simulationApplications​(SimulationApplicationConfig... simulationApplications)

        The simulation application to use in the simulation job.

        Parameters:
        simulationApplications - The simulation application to use in the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSources

        CreateSimulationJobRequest.Builder dataSources​(Collection<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.

        Parameters:
        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.

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

      • dataSources

        CreateSimulationJobRequest.Builder dataSources​(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.

        Parameters:
        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.

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

      • dataSources

        CreateSimulationJobRequest.Builder dataSources​(Consumer<DataSourceConfig.Builder>... 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.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dataSources(List).

        Parameters:
        dataSources - a consumer that will call methods on DataSourceConfig.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #dataSources(java.util.Collection)

      • tags

        CreateSimulationJobRequest.Builder tags​(Map<String,​String> tags)

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

        Parameters:
        tags - A map that contains tag keys and tag values that are attached to the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcConfig

        CreateSimulationJobRequest.Builder vpcConfig​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • compute

        CreateSimulationJobRequest.Builder compute​(Compute compute)

        Compute information for the simulation job.

        Parameters:
        compute - Compute information for the simulation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.