Google Cloud Gke Backup V1 Client - Class SubstitutionRule (0.3.1)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class SubstitutionRule.

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 substitution) and substitution logic.

Generated from protobuf message google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule

Namespace

Google \ Cloud \ GkeBackup \ V1 \ RestoreConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ target_namespaces array

(Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.

↳ target_group_kinds array<Google\Cloud\GkeBackup\V1\RestoreConfig\GroupKind>

(Filtering parameter) Any resource subject to substitution must belong to one of the listed "types". If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).

↳ target_json_path string

Required. This is a JSONPath expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).

↳ original_value_pattern string

(Filtering parameter) This is a regular expression that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters). Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.

↳ new_value string

This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").

getTargetNamespaces

(Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup.

If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTargetNamespaces

(Filtering parameter) Any resource subject to substitution must be contained within one of the listed Kubernetes Namespace in the Backup.

If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for substitution). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getTargetGroupKinds

(Filtering parameter) Any resource subject to substitution must belong to one of the listed "types".

If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTargetGroupKinds

(Filtering parameter) Any resource subject to substitution must belong to one of the listed "types".

If this field is not provided, no type filtering will be performed (all resources of all types matching previous filtering parameters will be candidates for substitution).

Parameter
NameDescription
var array<Google\Cloud\GkeBackup\V1\RestoreConfig\GroupKind>
Returns
TypeDescription
$this

getTargetJsonPath

Required. This is a JSONPath expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).

Returns
TypeDescription
string

setTargetJsonPath

Required. This is a JSONPath expression that matches specific fields of candidate resources and it operates as both a filtering parameter (resources that are not matched with this expression will not be candidates for substitution) as well as a field identifier (identifies exactly which fields out of the candidate resources will be modified).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOriginalValuePattern

(Filtering parameter) This is a regular expression that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters).

Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.

Returns
TypeDescription
string

setOriginalValuePattern

(Filtering parameter) This is a regular expression that is compared against the fields matched by the target_json_path expression (and must also have passed the previous filters).

Substitution will not be performed against fields whose value does not match this expression. If this field is NOT specified, then ALL fields matched by the target_json_path expression will undergo substitution. Note that an empty (e.g., "", rather than unspecified) value for this field will only match empty fields.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNewValue

This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").

Returns
TypeDescription
string

setNewValue

This is the new value to set for any fields that pass the filtering and selection criteria. To remove a value from a Kubernetes resource, either leave this field unspecified, or set it to the empty string ("").

Parameter
NameDescription
var string
Returns
TypeDescription
$this