class OCI::ObjectStorage::Models::ObjectNameFilter

A filter that compares object names to a set of prefixes or patterns to determine if a rule applies to a given object. The filter can contain include glob patterns, exclude glob patterns and inclusion prefixes. The inclusion prefixes property is kept for backward compatibility. It is recommended to use inclusion patterns instead of prefixes. Exclusions take precedence over inclusions.

Attributes

exclusion_patterns[RW]

An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself.

Glob patterns must be between 1 and 1024 characters.

The special pattern characters have the following meanings:

\\           Escapes the following character
*           Matches any string of characters.
?           Matches any single character .
[...]       Matches a group of characters. A group of characters can be:
                A set of characters, for example: [Zafg9@]. This matches any character in the brackets.
                A range of characters, for example: [a-z]. This matches any character in the range.
                    [a-f] is equivalent to [abcdef].
                    For character ranges only the CHARACTER-CHARACTER pattern is supported.
                        [ab-yz] is not valid
                        [a-mn-z] is not valid
                    Character ranges can not start with ^ or :
                    To include a '-' in the range, make it the first or last character.

@return [Array<String>]

inclusion_patterns[RW]

An array of glob patterns to match the object names to include. An empty array includes all objects in the bucket. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself.

Glob patterns must be between 1 and 1024 characters.

The special pattern characters have the following meanings:

\\           Escapes the following character
*           Matches any string of characters.
?           Matches any single character .
[...]       Matches a group of characters. A group of characters can be:
                A set of characters, for example: [Zafg9@]. This matches any character in the brackets.
                A range of characters, for example: [a-z]. This matches any character in the range.
                    [a-f] is equivalent to [abcdef].
                    For character ranges only the CHARACTER-CHARACTER pattern is supported.
                        [ab-yz] is not valid
                        [a-mn-z] is not valid
                    Character ranges can not start with ^ or :
                    To include a '-' in the range, make it the first or last character.

@return [Array<String>]

inclusion_prefixes[RW]

An array of object name prefixes that the rule will apply to. An empty array means to include all objects.

@return [Array<String>]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/object_storage/models/object_name_filter.rb, line 68
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'inclusion_prefixes': :'inclusionPrefixes',
    'inclusion_patterns': :'inclusionPatterns',
    'exclusion_patterns': :'exclusionPatterns'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<String>] :inclusion_prefixes The value to assign to the {#inclusion_prefixes} property @option attributes [Array<String>] :inclusion_patterns The value to assign to the {#inclusion_patterns} property @option attributes [Array<String>] :exclusion_patterns The value to assign to the {#exclusion_patterns} property

# File lib/oci/object_storage/models/object_name_filter.rb, line 98
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.inclusion_prefixes = attributes[:'inclusionPrefixes'] if attributes[:'inclusionPrefixes']

  raise 'You cannot provide both :inclusionPrefixes and :inclusion_prefixes' if attributes.key?(:'inclusionPrefixes') && attributes.key?(:'inclusion_prefixes')

  self.inclusion_prefixes = attributes[:'inclusion_prefixes'] if attributes[:'inclusion_prefixes']

  self.inclusion_patterns = attributes[:'inclusionPatterns'] if attributes[:'inclusionPatterns']

  raise 'You cannot provide both :inclusionPatterns and :inclusion_patterns' if attributes.key?(:'inclusionPatterns') && attributes.key?(:'inclusion_patterns')

  self.inclusion_patterns = attributes[:'inclusion_patterns'] if attributes[:'inclusion_patterns']

  self.exclusion_patterns = attributes[:'exclusionPatterns'] if attributes[:'exclusionPatterns']

  raise 'You cannot provide both :exclusionPatterns and :exclusion_patterns' if attributes.key?(:'exclusionPatterns') && attributes.key?(:'exclusion_patterns')

  self.exclusion_patterns = attributes[:'exclusion_patterns'] if attributes[:'exclusion_patterns']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/object_storage/models/object_name_filter.rb, line 79
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'inclusion_prefixes': :'Array<String>',
    'inclusion_patterns': :'Array<String>',
    'exclusion_patterns': :'Array<String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/object_name_filter.rb, line 130
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    inclusion_prefixes == other.inclusion_prefixes &&
    inclusion_patterns == other.inclusion_patterns &&
    exclusion_patterns == other.exclusion_patterns
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/object_storage/models/object_name_filter.rb, line 162
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/object_name_filter.rb, line 142
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/object_storage/models/object_name_filter.rb, line 151
def hash
  [inclusion_prefixes, inclusion_patterns, exclusion_patterns].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/object_storage/models/object_name_filter.rb, line 195
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/object_storage/models/object_name_filter.rb, line 189
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/object_storage/models/object_name_filter.rb, line 212
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end