Backup for GKE v1 API - Class RestoreConfig.Types.SubstitutionRule (2.1.0) 

public sealed class SubstitutionRule : IMessage<RestoreConfig.Types.SubstitutionRule>, IEquatable<RestoreConfig.Types.SubstitutionRule>, IDeepCloneable<RestoreConfig.Types.SubstitutionRule>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup for GKE v1 API class RestoreConfig.Types.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.

Inheritance

Object > RestoreConfig.Types.SubstitutionRule

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

SubstitutionRule()

public SubstitutionRule()

SubstitutionRule(RestoreConfig.Types.SubstitutionRule)

public SubstitutionRule(RestoreConfig.Types.SubstitutionRule other)
Parameter
NameDescription
otherRestoreConfig.Types.SubstitutionRule

Properties

NewValue

public string NewValue { get; set; }

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 ("").

Property Value
TypeDescription
String

OriginalValuePattern

public string OriginalValuePattern { get; set; }

(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 for this field will only match empty fields.

Property Value
TypeDescription
String

TargetGroupKinds

public RepeatedField<RestoreConfig.Types.GroupKind> TargetGroupKinds { get; }

(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).

Property Value
TypeDescription
RepeatedField<RestoreConfig.Types.GroupKind>

TargetJsonPath

public string TargetJsonPath { get; set; }

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).

Property Value
TypeDescription
String

TargetNamespaces

public RepeatedField<string> TargetNamespaces { get; }

(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.

Property Value
TypeDescription
RepeatedField<String>