Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class TransformationRule.
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to transform) and transformation logic.
Generated from protobuf message google.cloud.gkebackup.v1.RestoreConfig.TransformationRule
Namespace
Google \ Cloud \ GkeBackup \ V1 \ RestoreConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field_actions |
array<Google\Cloud\GkeBackup\V1\RestoreConfig\TransformationRuleAction>
Required. A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation. |
↳ resource_filter |
Google\Cloud\GkeBackup\V1\RestoreConfig\ResourceFilter
This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions. |
↳ description |
string
The description is a user specified string description of the transformation rule. |
getFieldActions
Required. A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFieldActions
Required. A list of transformation rule actions to take against candidate resources. Actions are executed in order defined - this order matters, as they could potentially interfere with each other and the first operation could affect the outcome of the second operation.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\GkeBackup\V1\RestoreConfig\TransformationRuleAction>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceFilter
This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\RestoreConfig\ResourceFilter|null | |
hasResourceFilter
clearResourceFilter
setResourceFilter
This field is used to specify a set of fields that should be used to determine which resources in backup should be acted upon by the supplied transformation rule actions, and this will ensure that only specific resources are affected by transformation rule actions.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\RestoreConfig\ResourceFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
The description is a user specified string description of the transformation rule.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
The description is a user specified string description of the transformation rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |