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
Namespace
Google \ Cloud \ OsConfig \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string |
|
hasLocalPath
setLocalPath
An absolute path to the executable on the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcsObject
A Cloud Storage object containing the executable.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\OsConfig\V1\GcsObject|null |
|
hasGcsObject
setGcsObject
A Cloud Storage object containing the executable.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\OsConfig\V1\GcsObject
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowedSuccessCodes
Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllowedSuccessCodes
Defaults to [0]. A list of possible return values that the execution can return to indicate a success.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecutable
| Returns | |
|---|---|
| Type | Description |
string |
|