Package com.google.cloud.gkebackup.v1
Class RestoreConfig.SubstitutionRule
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule
- All Implemented Interfaces:
RestoreConfig.SubstitutionRuleOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
- Enclosing class:
- RestoreConfig
public static final class RestoreConfig.SubstitutionRule
extends com.google.protobuf.GeneratedMessage
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- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic final com.google.protobuf.Descriptors.DescriptorOptional.com.google.protobuf.ByteStringOptional.Optional.com.google.protobuf.ByteStringOptional.com.google.protobuf.Parser<RestoreConfig.SubstitutionRule>intgetTargetGroupKinds(int index) Optional.intOptional.Optional.getTargetGroupKindsOrBuilder(int index) Optional.List<? extends RestoreConfig.GroupKindOrBuilder>Optional.Required.com.google.protobuf.ByteStringRequired.getTargetNamespaces(int index) Optional.com.google.protobuf.ByteStringgetTargetNamespacesBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilder(RestoreConfig.SubstitutionRule prototype) protected RestoreConfig.SubstitutionRule.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<RestoreConfig.SubstitutionRule>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
TARGET_NAMESPACES_FIELD_NUMBER
public static final int TARGET_NAMESPACES_FIELD_NUMBER- See Also:
-
TARGET_GROUP_KINDS_FIELD_NUMBER
public static final int TARGET_GROUP_KINDS_FIELD_NUMBER- See Also:
-
TARGET_JSON_PATH_FIELD_NUMBER
public static final int TARGET_JSON_PATH_FIELD_NUMBER- See Also:
-
ORIGINAL_VALUE_PATTERN_FIELD_NUMBER
public static final int ORIGINAL_VALUE_PATTERN_FIELD_NUMBER- See Also:
-
NEW_VALUE_FIELD_NUMBER
public static final int NEW_VALUE_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getTargetNamespacesList
public com.google.protobuf.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];- Specified by:
getTargetNamespacesListin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- A list containing the targetNamespaces.
-
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];- Specified by:
getTargetNamespacesCountin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The count of targetNamespaces.
-
getTargetNamespaces
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];- Specified by:
getTargetNamespacesin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The targetNamespaces at the given index.
-
getTargetNamespacesBytes
public com.google.protobuf.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];- Specified by:
getTargetNamespacesBytesin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the targetNamespaces at the given index.
-
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];- Specified by:
getTargetGroupKindsListin interfaceRestoreConfig.SubstitutionRuleOrBuilder
-
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];- Specified by:
getTargetGroupKindsOrBuilderListin interfaceRestoreConfig.SubstitutionRuleOrBuilder
-
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];- Specified by:
getTargetGroupKindsCountin interfaceRestoreConfig.SubstitutionRuleOrBuilder
-
getTargetGroupKinds
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];- Specified by:
getTargetGroupKindsin interfaceRestoreConfig.SubstitutionRuleOrBuilder
-
getTargetGroupKindsOrBuilder
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];- Specified by:
getTargetGroupKindsOrBuilderin interfaceRestoreConfig.SubstitutionRuleOrBuilder
-
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];- Specified by:
getTargetJsonPathin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The targetJsonPath.
-
getTargetJsonPathBytes
public 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];- Specified by:
getTargetJsonPathBytesin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The bytes for targetJsonPath.
-
getOriginalValuePattern
Optional. (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 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOriginalValuePatternin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The originalValuePattern.
-
getOriginalValuePatternBytes
public com.google.protobuf.ByteString getOriginalValuePatternBytes()Optional. (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 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getOriginalValuePatternBytesin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The bytes for originalValuePattern.
-
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];- Specified by:
getNewValuein interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The newValue.
-
getNewValueBytes
public com.google.protobuf.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];- Specified by:
getNewValueBytesin interfaceRestoreConfig.SubstitutionRuleOrBuilder- Returns:
- The bytes for newValue.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static RestoreConfig.SubstitutionRule parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static RestoreConfig.SubstitutionRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RestoreConfig.SubstitutionRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static RestoreConfig.SubstitutionRule.Builder newBuilder(RestoreConfig.SubstitutionRule prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RestoreConfig.SubstitutionRule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-