Class: OCI::NetworkFirewall::Models::SimpleUrlPattern

Inherits:
UrlPattern
  • Object
show all
Defined in:
lib/oci/network_firewall/models/simple_url_pattern.rb

Overview

Pattern describing an http/https URL or set thereof as a concatenation of optional host component and optional path component.

*.example.com will match example.com/ and foo.example.com/foo?bar.

www.example.com/foo* will match www.example.com/foo and www.exampe.com/foobar and www.example.com/foo/bar?baz, but not sub.www.example.com/foo or www.example.com/FOO.

.example.com/foo will match example.com/foo and sub2.sub.example.com/foo/bar?baz, but not example.com/FOO.

Constant Summary

Constants inherited from UrlPattern

UrlPattern::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UrlPattern

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UrlPattern

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SimpleUrlPattern

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :pattern (String) —

    The value to assign to the #pattern property



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 57

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'SIMPLE'

  super(attributes)

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

  self.pattern = attributes[:'pattern'] if attributes[:'pattern']
end

Instance Attribute Details

#pattern ⇒ String

[Required] A string consisting of a concatenation of optional host component and optional path component. The host component may start with *. to match the case-insensitive domain and all its subdomains. The path component must start with a /, and may end with * to match all paths of which it is a case-sensitive prefix. A missing host component matches all request domains, and a missing path component matches all request paths. An empty value matches all requests.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 28

def pattern
  @pattern
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'pattern': :'pattern'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'pattern': :'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



77
78
79
80
81
82
83
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 77

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    pattern == other.pattern
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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 108

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


88
89
90
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 88

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



97
98
99
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 97

def hash
  [type, pattern].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 141

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



135
136
137
 
# File 'lib/oci/network_firewall/models/simple_url_pattern.rb', line 135

def to_s
  to_hash.to_s
end