Class: OCI::ObjectStorage::Models::ObjectNameFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/object_name_filter.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObjectNameFilter

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :inclusion_prefixes (Array<String>) —

    The value to assign to the #inclusion_prefixes property

  • :inclusion_patterns (Array<String>) —

    The value to assign to the #inclusion_patterns property

  • :exclusion_patterns (Array<String>) —

    The value to assign to the #exclusion_patterns property



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 99

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

Instance Attribute Details

#exclusion_patterns ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


66
67
68
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 66

def exclusion_patterns
  @exclusion_patterns
end

#inclusion_patterns ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


42
43
44
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 42

def inclusion_patterns
  @inclusion_patterns
end

#inclusion_prefixes ⇒ Array<String>

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

Returns:

  • (Array<String>) 


18
19
20
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 18

def inclusion_prefixes
  @inclusion_prefixes
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'inclusion_prefixes': :'inclusionPrefixes',
    'inclusion_patterns': :'inclusionPatterns',
    'exclusion_patterns': :'exclusionPatterns'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 80

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



131
132
133
134
135
136
137
138
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 131

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 163

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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 152

def hash
  [inclusion_prefixes, inclusion_patterns, exclusion_patterns].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 196

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



190
191
192
 
# File 'lib/oci/object_storage/models/object_name_filter.rb', line 190

def to_s
  to_hash.to_s
end