public static final class RestoreConfig.SubstitutionRule extends com.google.protobuf.GeneratedMessageV3 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| Modifier and Type | Class and Description |
|---|---|
static class |
RestoreConfig.SubstitutionRule.Builder
A transformation rule to be applied against Kubernetes resources as they
are selected for restoration from a Backup.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
NEW_VALUE_FIELD_NUMBER |
static int |
ORIGINAL_VALUE_PATTERN_FIELD_NUMBER |
static int |
TARGET_GROUP_KINDS_FIELD_NUMBER |
static int |
TARGET_JSON_PATH_FIELD_NUMBER |
static int |
TARGET_NAMESPACES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static RestoreConfig.SubstitutionRule |
getDefaultInstance() |
RestoreConfig.SubstitutionRule |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getNewValue()
This is the new value to set for any fields that pass the filtering and
selection criteria.
|
com.google.protobuf.ByteString |
getNewValueBytes()
This is the new value to set for any fields that pass the filtering and
selection criteria.
|
String |
getOriginalValuePattern()
(Filtering parameter) This is a [regular expression]
(https://en.wikipedia.org/wiki/Regular_expression)
that is compared against the fields matched by the target_json_path
expression (and must also have passed the previous filters).
|
com.google.protobuf.ByteString |
getOriginalValuePatternBytes()
(Filtering parameter) This is a [regular expression]
(https://en.wikipedia.org/wiki/Regular_expression)
that is compared against the fields matched by the target_json_path
expression (and must also have passed the previous filters).
|
com.google.protobuf.Parser<RestoreConfig.SubstitutionRule> |
getParserForType() |
int |
getSerializedSize() |
RestoreConfig.GroupKind |
getTargetGroupKinds(int index)
(Filtering parameter) Any resource subject to substitution must belong to
one of the listed "types".
|
int |
getTargetGroupKindsCount()
(Filtering parameter) Any resource subject to substitution must belong to
one of the listed "types".
|
List<RestoreConfig.GroupKind> |
getTargetGroupKindsList()
(Filtering parameter) Any resource subject to substitution must belong to
one of the listed "types".
|
RestoreConfig.GroupKindOrBuilder |
getTargetGroupKindsOrBuilder(int index)
(Filtering parameter) Any resource subject to substitution must belong to
one of the listed "types".
|
List<? extends RestoreConfig.GroupKindOrBuilder> |
getTargetGroupKindsOrBuilderList()
(Filtering parameter) Any resource subject to substitution must belong to
one of the listed "types".
|
String |
getTargetJsonPath()
Required.
|
com.google.protobuf.ByteString |
getTargetJsonPathBytes()
Required.
|
String |
getTargetNamespaces(int index)
(Filtering parameter) Any resource subject to substitution must be
contained within one of the listed Kubernetes Namespace in the Backup.
|
com.google.protobuf.ByteString |
getTargetNamespacesBytes(int index)
(Filtering parameter) Any resource subject to substitution must be
contained within one of the listed Kubernetes Namespace in the Backup.
|
int |
getTargetNamespacesCount()
(Filtering parameter) Any resource subject to substitution must be
contained within one of the listed Kubernetes Namespace in the Backup.
|
com.google.protobuf.ProtocolStringList |
getTargetNamespacesList()
(Filtering parameter) Any resource subject to substitution must be
contained within one of the listed Kubernetes Namespace in the Backup.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static RestoreConfig.SubstitutionRule.Builder |
newBuilder() |
static RestoreConfig.SubstitutionRule.Builder |
newBuilder(RestoreConfig.SubstitutionRule prototype) |
RestoreConfig.SubstitutionRule.Builder |
newBuilderForType() |
protected RestoreConfig.SubstitutionRule.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static RestoreConfig.SubstitutionRule |
parseDelimitedFrom(InputStream input) |
static RestoreConfig.SubstitutionRule |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestoreConfig.SubstitutionRule |
parseFrom(byte[] data) |
static RestoreConfig.SubstitutionRule |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestoreConfig.SubstitutionRule |
parseFrom(ByteBuffer data) |
static RestoreConfig.SubstitutionRule |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestoreConfig.SubstitutionRule |
parseFrom(com.google.protobuf.ByteString data) |
static RestoreConfig.SubstitutionRule |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestoreConfig.SubstitutionRule |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RestoreConfig.SubstitutionRule |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestoreConfig.SubstitutionRule |
parseFrom(InputStream input) |
static RestoreConfig.SubstitutionRule |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RestoreConfig.SubstitutionRule> |
parser() |
RestoreConfig.SubstitutionRule.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TARGET_NAMESPACES_FIELD_NUMBER
public static final int TARGET_GROUP_KINDS_FIELD_NUMBER
public static final int TARGET_JSON_PATH_FIELD_NUMBER
public static final int ORIGINAL_VALUE_PATTERN_FIELD_NUMBER
public static final int NEW_VALUE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public com.google.protobuf.ProtocolStringList getTargetNamespacesList()
(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;getTargetNamespacesList in interface RestoreConfig.SubstitutionRuleOrBuilderpublic int getTargetNamespacesCount()
(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;getTargetNamespacesCount in interface RestoreConfig.SubstitutionRuleOrBuilderpublic String getTargetNamespaces(int index)
(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;getTargetNamespaces in interface RestoreConfig.SubstitutionRuleOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getTargetNamespacesBytes(int index)
(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;getTargetNamespacesBytes in interface RestoreConfig.SubstitutionRuleOrBuilderindex - The index of the value to return.public List<RestoreConfig.GroupKind> getTargetGroupKindsList()
(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;
getTargetGroupKindsList in interface RestoreConfig.SubstitutionRuleOrBuilderpublic List<? extends RestoreConfig.GroupKindOrBuilder> getTargetGroupKindsOrBuilderList()
(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;
getTargetGroupKindsOrBuilderList in interface RestoreConfig.SubstitutionRuleOrBuilderpublic int getTargetGroupKindsCount()
(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;
getTargetGroupKindsCount in interface RestoreConfig.SubstitutionRuleOrBuilderpublic RestoreConfig.GroupKind getTargetGroupKinds(int index)
(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;
getTargetGroupKinds in interface RestoreConfig.SubstitutionRuleOrBuilderpublic RestoreConfig.GroupKindOrBuilder getTargetGroupKindsOrBuilder(int index)
(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;
getTargetGroupKindsOrBuilder in interface RestoreConfig.SubstitutionRuleOrBuilderpublic String getTargetJsonPath()
Required. This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/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];getTargetJsonPath in interface RestoreConfig.SubstitutionRuleOrBuilderpublic com.google.protobuf.ByteString getTargetJsonPathBytes()
Required. This is a [JSONPath] (https://kubernetes.io/docs/reference/kubectl/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];getTargetJsonPathBytes in interface RestoreConfig.SubstitutionRuleOrBuilderpublic String getOriginalValuePattern()
(Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/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;getOriginalValuePattern in interface RestoreConfig.SubstitutionRuleOrBuilderpublic com.google.protobuf.ByteString getOriginalValuePatternBytes()
(Filtering parameter) This is a [regular expression] (https://en.wikipedia.org/wiki/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;getOriginalValuePatternBytes in interface RestoreConfig.SubstitutionRuleOrBuilderpublic String 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 ("").
string new_value = 5;getNewValue in interface RestoreConfig.SubstitutionRuleOrBuilderpublic com.google.protobuf.ByteString getNewValueBytes()
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;getNewValueBytes in interface RestoreConfig.SubstitutionRuleOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RestoreConfig.SubstitutionRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(InputStream input) throws IOException
IOExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RestoreConfig.SubstitutionRule parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RestoreConfig.SubstitutionRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RestoreConfig.SubstitutionRule.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RestoreConfig.SubstitutionRule.Builder newBuilder()
public static RestoreConfig.SubstitutionRule.Builder newBuilder(RestoreConfig.SubstitutionRule prototype)
public RestoreConfig.SubstitutionRule.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RestoreConfig.SubstitutionRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RestoreConfig.SubstitutionRule getDefaultInstance()
public static com.google.protobuf.Parser<RestoreConfig.SubstitutionRule> parser()
public com.google.protobuf.Parser<RestoreConfig.SubstitutionRule> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RestoreConfig.SubstitutionRule getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.