Struct HostConfigurationBuilder 

#[non_exhaustive]
pub struct HostConfigurationBuilder { /* private fields */ }

A builder for HostConfiguration.

Implementations

impl HostConfigurationBuilder

pub fn script_body(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_script_body(self, input: Option<String>) -> Self

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

pub fn get_script_body(&self) -> &Option<String>

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

pub fn script_timeout_seconds(self, input: i32) -> Self

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

pub fn set_script_timeout_seconds(self, input: Option<i32>) -> Self

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

pub fn get_script_timeout_seconds(&self) -> &Option<i32>

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

pub fn build(self) -> Result<HostConfiguration, BuildError>

Consumes the builder and constructs a HostConfiguration. This method will fail if any of the following fields are not set:

• script_body

Trait Implementations

impl Clone for HostConfigurationBuilder

fn clone(&self) -> HostConfigurationBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HostConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HostConfigurationBuilder

fn default() -> HostConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for HostConfigurationBuilder

fn eq(&self, other: &HostConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HostConfigurationBuilder