Class: OCI::Waas::Models::Origin

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waas/models/origin.rb

Overview

A detailed description of your web application’s origin host server. An origin must be defined to set up WAF rules.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Origin

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/waas/models/origin.rb', line 59

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.uri = attributes[:'uri'] if attributes[:'uri']

  self.http_port = attributes[:'httpPort'] if attributes[:'httpPort']

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

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

  self.https_port = attributes[:'httpsPort'] if attributes[:'httpsPort']

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

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

  self.custom_headers = attributes[:'customHeaders'] if attributes[:'customHeaders']

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

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

Instance Attribute Details

#custom_headers ⇒ Array<OCI::Waas::Models::Header>

A list of HTTP headers to forward to your origin.

Returns:



23
24
25
 
# File 'lib/oci/waas/models/origin.rb', line 23

def custom_headers
  @custom_headers
end

#http_port ⇒ Integer

The HTTP port on the origin that the web application listens on. If unspecified, defaults to ‘80`.

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/oci/waas/models/origin.rb', line 15

def http_port
  @http_port
end

#https_port ⇒ Integer

The HTTPS port on the origin that the web application listens on. If unspecified, defaults to ‘443`.

Returns:

  • (Integer) 


19
20
21
 
# File 'lib/oci/waas/models/origin.rb', line 19

def https_port
  @https_port
end

#uri ⇒ String

[Required] The URI of the origin. Does not support paths. Port numbers should be specified in the ‘httpPort` and `httpsPort` fields.

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/waas/models/origin.rb', line 11

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/waas/models/origin.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'uri': :'uri',
    'http_port': :'httpPort',
    'https_port': :'httpsPort',
    'custom_headers': :'customHeaders'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/waas/models/origin.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'uri': :'String',
    'http_port': :'Integer',
    'https_port': :'Integer',
    'custom_headers': :'Array<OCI::Waas::Models::Header>'
    # 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



93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/waas/models/origin.rb', line 93

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

  self.class == other.class &&
    uri == other.uri &&
    http_port == other.http_port &&
    https_port == other.https_port &&
    custom_headers == other.custom_headers
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/waas/models/origin.rb', line 126

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


106
107
108
 
# File 'lib/oci/waas/models/origin.rb', line 106

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/oci/waas/models/origin.rb', line 115

def hash
  [uri, http_port, https_port, custom_headers].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/waas/models/origin.rb', line 159

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



153
154
155
 
# File 'lib/oci/waas/models/origin.rb', line 153

def to_s
  to_hash.to_s
end