Reference documentation and code samples for the Google Cloud Batch V1 Client class Environment.
An Environment describes a collection of environment variables to set when executing Tasks.
Generated from protobuf message google.cloud.batch.v1.Environment
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ variables |
array|Google\Protobuf\Internal\MapField
A map of environment variable names to values. |
↳ secret_variables |
array|Google\Protobuf\Internal\MapField
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. |
↳ encrypted_variables |
Google\Cloud\Batch\V1\Environment\KMSEnvMap
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. |
getVariables
A map of environment variable names to values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setVariables
A map of environment variable names to values.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecretVariables
A map of environment variable names to Secret Manager secret names.
The VM will access the named secrets to set the value of each environment variable.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setSecretVariables
A map of environment variable names to Secret Manager secret names.
The VM will access the named secrets to set the value of each environment variable.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptedVariables
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Batch\V1\Environment\KMSEnvMap|null | |
hasEncryptedVariables
clearEncryptedVariables
setEncryptedVariables
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Batch\V1\Environment\KMSEnvMap
|
| Returns | |
|---|---|
| Type | Description |
$this | |