Google Cloud Gke Backup V1 Client - Class TransformationRule (0.6.0)

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 \ RestoreConfig

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var array<Google\Cloud\GkeBackup\V1\RestoreConfig\TransformationRuleAction>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\GkeBackup\V1\RestoreConfig\ResourceFilter
Returns
TypeDescription
$this

getDescription

The description is a user specified string description of the transformation rule.

Returns
TypeDescription
string

setDescription

The description is a user specified string description of the transformation rule.

Parameter
NameDescription
var string
Returns
TypeDescription
$this