Google Cloud OsConfig V1 Client - Class ExecStepConfig (1.0.5)

Reference documentation and code samples for the Google Cloud OsConfig V1 Client class ExecStepConfig.

Common configurations for an ExecStep.

Generated from protobuf message google.cloud.osconfig.v1.ExecStepConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ local_path string

An absolute path to the executable on the VM.

↳ gcs_object Google\Cloud\OsConfig\V1\GcsObject

A Cloud Storage object containing the executable.

↳ allowed_success_codes array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

↳ interpreter int

The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines.

getLocalPath

An absolute path to the executable on the VM.

Returns
TypeDescription
string

hasLocalPath

setLocalPath

An absolute path to the executable on the VM.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGcsObject

A Cloud Storage object containing the executable.

Returns
TypeDescription
Google\Cloud\OsConfig\V1\GcsObject|null

hasGcsObject

setGcsObject

A Cloud Storage object containing the executable.

Parameter
NameDescription
var Google\Cloud\OsConfig\V1\GcsObject
Returns
TypeDescription
$this

getAllowedSuccessCodes

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAllowedSuccessCodes

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getInterpreter

The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines.

Returns
TypeDescription
int

setInterpreter

The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with shebang lines.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExecutable

Returns
TypeDescription
string