Interface RestoreConfig.SubstitutionRuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RestoreConfig.SubstitutionRule, RestoreConfig.SubstitutionRule.Builder
Enclosing class:
RestoreConfig

public static interface RestoreConfig.SubstitutionRuleOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getTargetNamespacesList

      List<String> 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:
      A list containing the targetNamespaces.
    • getTargetNamespacesCount

      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:
      The count of targetNamespaces.
    • getTargetNamespaces

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The targetNamespaces at the given index.
    • getTargetNamespacesBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the targetNamespaces at the given index.
    • getTargetGroupKindsList

      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];
    • getTargetGroupKinds

      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];
    • getTargetGroupKindsCount

      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];
    • getTargetGroupKindsOrBuilderList

      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];
    • getTargetGroupKindsOrBuilder

      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];
    • getTargetJsonPath

      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];
      Returns:
      The targetJsonPath.
    • getTargetJsonPathBytes

      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];
      Returns:
      The bytes for targetJsonPath.
    • getOriginalValuePattern

      String 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];
      Returns:
      The originalValuePattern.
    • getOriginalValuePatternBytes

      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];
      Returns:
      The bytes for originalValuePattern.
    • getNewValue

      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:
      The newValue.
    • getNewValueBytes

      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];
      Returns:
      The bytes for newValue.