Class RestoreConfig.SubstitutionRule.Builder (0.51.0) 

public static final class RestoreConfig.SubstitutionRule.Builder extends GeneratedMessageV3.Builder<RestoreConfig.SubstitutionRule.Builder> implements RestoreConfig.SubstitutionRuleOrBuilder

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.

Protobuf type google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RestoreConfig.SubstitutionRule.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllTargetGroupKinds(Iterable<? extends RestoreConfig.GroupKind> values)

public RestoreConfig.SubstitutionRule.Builder addAllTargetGroupKinds(Iterable<? extends RestoreConfig.GroupKind> values)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.gkebackup.v1.RestoreConfig.GroupKind>
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

addAllTargetNamespaces(Iterable<String> values)

public RestoreConfig.SubstitutionRule.Builder addAllTargetNamespaces(Iterable<String> values)

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The targetNamespaces to add.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RestoreConfig.SubstitutionRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

addTargetGroupKinds(RestoreConfig.GroupKind value)

public RestoreConfig.SubstitutionRule.Builder addTargetGroupKinds(RestoreConfig.GroupKind value)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RestoreConfig.GroupKind
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

addTargetGroupKinds(RestoreConfig.GroupKind.Builder builderForValue)

public RestoreConfig.SubstitutionRule.Builder addTargetGroupKinds(RestoreConfig.GroupKind.Builder builderForValue)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue RestoreConfig.GroupKind.Builder
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

addTargetGroupKinds(int index, RestoreConfig.GroupKind value)

public RestoreConfig.SubstitutionRule.Builder addTargetGroupKinds(int index, RestoreConfig.GroupKind value)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value RestoreConfig.GroupKind
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

addTargetGroupKinds(int index, RestoreConfig.GroupKind.Builder builderForValue)

public RestoreConfig.SubstitutionRule.Builder addTargetGroupKinds(int index, RestoreConfig.GroupKind.Builder builderForValue)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue RestoreConfig.GroupKind.Builder
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

addTargetGroupKindsBuilder()

public RestoreConfig.GroupKind.Builder addTargetGroupKindsBuilder()

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.GroupKind.Builder

addTargetGroupKindsBuilder(int index)

public RestoreConfig.GroupKind.Builder addTargetGroupKindsBuilder(int index)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKind.Builder

addTargetNamespaces(String value)

public RestoreConfig.SubstitutionRule.Builder addTargetNamespaces(String value)

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The targetNamespaces to add.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

addTargetNamespacesBytes(ByteString value)

public RestoreConfig.SubstitutionRule.Builder addTargetNamespacesBytes(ByteString value)

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the targetNamespaces to add.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

build()

public RestoreConfig.SubstitutionRule build()
Returns
Type Description
RestoreConfig.SubstitutionRule

buildPartial()

public RestoreConfig.SubstitutionRule buildPartial()
Returns
Type Description
RestoreConfig.SubstitutionRule

clear()

public RestoreConfig.SubstitutionRule.Builder clear()
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RestoreConfig.SubstitutionRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

clearNewValue()

public RestoreConfig.SubstitutionRule.Builder clearNewValue()

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

string new_value = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RestoreConfig.SubstitutionRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

clearOriginalValuePattern()

public RestoreConfig.SubstitutionRule.Builder clearOriginalValuePattern()

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

string original_value_pattern = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

clearTargetGroupKinds()

public RestoreConfig.SubstitutionRule.Builder clearTargetGroupKinds()

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

clearTargetJsonPath()

public RestoreConfig.SubstitutionRule.Builder clearTargetJsonPath()

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

string target_json_path = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

clearTargetNamespaces()

public RestoreConfig.SubstitutionRule.Builder clearTargetNamespaces()

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

clone()

public RestoreConfig.SubstitutionRule.Builder clone()
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

getDefaultInstanceForType()

public RestoreConfig.SubstitutionRule getDefaultInstanceForType()
Returns
Type Description
RestoreConfig.SubstitutionRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getNewValue()

public String getNewValue()

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

string new_value = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The newValue.

getNewValueBytes()

public ByteString getNewValueBytes()

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

string new_value = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for newValue.

getOriginalValuePattern()

public String getOriginalValuePattern()

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

string original_value_pattern = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The originalValuePattern.

getOriginalValuePatternBytes()

public ByteString getOriginalValuePatternBytes()

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

string original_value_pattern = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for originalValuePattern.

getTargetGroupKinds(int index)

public RestoreConfig.GroupKind getTargetGroupKinds(int index)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKind

getTargetGroupKindsBuilder(int index)

public RestoreConfig.GroupKind.Builder getTargetGroupKindsBuilder(int index)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKind.Builder

getTargetGroupKindsBuilderList()

public List<RestoreConfig.GroupKind.Builder> getTargetGroupKindsBuilderList()

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getTargetGroupKindsCount()

public int getTargetGroupKindsCount()

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTargetGroupKindsList()

public List<RestoreConfig.GroupKind> getTargetGroupKindsList()

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GroupKind>

getTargetGroupKindsOrBuilder(int index)

public RestoreConfig.GroupKindOrBuilder getTargetGroupKindsOrBuilder(int index)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.GroupKindOrBuilder

getTargetGroupKindsOrBuilderList()

public List<? extends RestoreConfig.GroupKindOrBuilder> getTargetGroupKindsOrBuilderList()

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.GroupKindOrBuilder>

getTargetJsonPath()

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

string target_json_path = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The targetJsonPath.

getTargetJsonPathBytes()

public ByteString getTargetJsonPathBytes()

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

string target_json_path = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for targetJsonPath.

getTargetNamespaces(int index)

public String getTargetNamespaces(int index)

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The targetNamespaces at the given index.

getTargetNamespacesBytes(int index)

public ByteString getTargetNamespacesBytes(int index)

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the targetNamespaces at the given index.

getTargetNamespacesCount()

public int getTargetNamespacesCount()

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of targetNamespaces.

getTargetNamespacesList()

public ProtocolStringList getTargetNamespacesList()

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the targetNamespaces.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RestoreConfig.SubstitutionRule other)

public RestoreConfig.SubstitutionRule.Builder mergeFrom(RestoreConfig.SubstitutionRule other)
Parameter
Name Description
other RestoreConfig.SubstitutionRule
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RestoreConfig.SubstitutionRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RestoreConfig.SubstitutionRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreConfig.SubstitutionRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

removeTargetGroupKinds(int index)

public RestoreConfig.SubstitutionRule.Builder removeTargetGroupKinds(int index)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RestoreConfig.SubstitutionRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

setNewValue(String value)

public RestoreConfig.SubstitutionRule.Builder setNewValue(String value)

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

string new_value = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The newValue to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setNewValueBytes(ByteString value)

public RestoreConfig.SubstitutionRule.Builder setNewValueBytes(ByteString value)

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

string new_value = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for newValue to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setOriginalValuePattern(String value)

public RestoreConfig.SubstitutionRule.Builder setOriginalValuePattern(String value)

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

string original_value_pattern = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The originalValuePattern to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setOriginalValuePatternBytes(ByteString value)

public RestoreConfig.SubstitutionRule.Builder setOriginalValuePatternBytes(ByteString value)

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

string original_value_pattern = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for originalValuePattern to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RestoreConfig.SubstitutionRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides

setTargetGroupKinds(int index, RestoreConfig.GroupKind value)

public RestoreConfig.SubstitutionRule.Builder setTargetGroupKinds(int index, RestoreConfig.GroupKind value)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value RestoreConfig.GroupKind
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

setTargetGroupKinds(int index, RestoreConfig.GroupKind.Builder builderForValue)

public RestoreConfig.SubstitutionRule.Builder setTargetGroupKinds(int index, RestoreConfig.GroupKind.Builder builderForValue)

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

repeated .google.cloud.gkebackup.v1.RestoreConfig.GroupKind target_group_kinds = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue RestoreConfig.GroupKind.Builder
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

setTargetJsonPath(String value)

public RestoreConfig.SubstitutionRule.Builder setTargetJsonPath(String value)

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

string target_json_path = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The targetJsonPath to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setTargetJsonPathBytes(ByteString value)

public RestoreConfig.SubstitutionRule.Builder setTargetJsonPathBytes(ByteString value)

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

string target_json_path = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for targetJsonPath to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setTargetNamespaces(int index, String value)

public RestoreConfig.SubstitutionRule.Builder setTargetNamespaces(int index, String value)

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

repeated string target_namespaces = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value String

The targetNamespaces to set.
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RestoreConfig.SubstitutionRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RestoreConfig.SubstitutionRule.Builder
Overrides