Reference documentation and code samples for the Google Cloud Container V1 Client class SwapConfig.
Configuration for swap memory on a node pool.
Generated from protobuf message google.container.v1.LinuxNodeConfig.SwapConfig
Namespace
Google \ Cloud \ Container \ V1 \ LinuxNodeConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enabled |
bool
Optional. Enables or disables swap for the node pool. |
↳ encryption_config |
SwapConfig\EncryptionConfig
Optional. If omitted, swap space is encrypted by default. |
↳ boot_disk_profile |
SwapConfig\BootDiskProfile
Swap on the node's boot disk. |
↳ ephemeral_local_ssd_profile |
SwapConfig\EphemeralLocalSsdProfile
Swap on the local SSD shared with pod ephemeral storage. |
↳ dedicated_local_ssd_profile |
SwapConfig\DedicatedLocalSsdProfile
Provisions a new, separate local NVMe SSD exclusively for swap. |
getEnabled
Optional. Enables or disables swap for the node pool.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasEnabled
clearEnabled
setEnabled
Optional. Enables or disables swap for the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionConfig
Optional. If omitted, swap space is encrypted by default.
| Returns | |
|---|---|
| Type | Description |
SwapConfig\EncryptionConfig|null |
|
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Optional. If omitted, swap space is encrypted by default.
| Parameter | |
|---|---|
| Name | Description |
var |
SwapConfig\EncryptionConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBootDiskProfile
Swap on the node's boot disk.
| Returns | |
|---|---|
| Type | Description |
SwapConfig\BootDiskProfile|null |
|
hasBootDiskProfile
setBootDiskProfile
Swap on the node's boot disk.
| Parameter | |
|---|---|
| Name | Description |
var |
SwapConfig\BootDiskProfile
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEphemeralLocalSsdProfile
Swap on the local SSD shared with pod ephemeral storage.
| Returns | |
|---|---|
| Type | Description |
SwapConfig\EphemeralLocalSsdProfile|null |
|
hasEphemeralLocalSsdProfile
setEphemeralLocalSsdProfile
Swap on the local SSD shared with pod ephemeral storage.
| Parameter | |
|---|---|
| Name | Description |
var |
SwapConfig\EphemeralLocalSsdProfile
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDedicatedLocalSsdProfile
Provisions a new, separate local NVMe SSD exclusively for swap.
| Returns | |
|---|---|
| Type | Description |
SwapConfig\DedicatedLocalSsdProfile|null |
|
hasDedicatedLocalSsdProfile
setDedicatedLocalSsdProfile
Provisions a new, separate local NVMe SSD exclusively for swap.
| Parameter | |
|---|---|
| Name | Description |
var |
SwapConfig\DedicatedLocalSsdProfile
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPerformanceProfile
| Returns | |
|---|---|
| Type | Description |
string |
|