Interface HostConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HostConfiguration.Builder,HostConfiguration>, SdkBuilder<HostConfiguration.Builder,HostConfiguration>, SdkPojo
Enclosing class:
HostConfiguration
@Mutable @NotThreadSafe public static interface HostConfiguration.Builder extends SdkPojo, CopyableBuilder<HostConfiguration.Builder,HostConfiguration>

  • Method Details

    • scriptBody

      HostConfiguration.Builder scriptBody(String scriptBody)

      The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.

      For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.

      The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).

      Parameters:
      scriptBody - The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.

      For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.

      The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).

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

    • scriptTimeoutSeconds

      HostConfiguration.Builder scriptTimeoutSeconds(Integer scriptTimeoutSeconds)

      The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.

      You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.

      The default is 300 seconds (5 minutes).

      Parameters:
      scriptTimeoutSeconds - The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.

      You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.

      The default is 300 seconds (5 minutes).

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