Class: OCI::Waas::Models::HttpRedirectTarget

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

Overview

HttpRedirectTarget model.

Constant Summary collapse

PROTOCOL_ENUM =
[
  PROTOCOL_HTTP = 'HTTP'.freeze,
  PROTOCOL_HTTPS = 'HTTPS'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HttpRedirectTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :protocol (String)

    The value to assign to the #protocol property

  • :host (String)

    The value to assign to the #host property

  • :port (Integer)

    The value to assign to the #port property

  • :path (String)

    The value to assign to the #path property

  • :query (String)

    The value to assign to the #query property



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/oci/waas/models/http_redirect_target.rb', line 74

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

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

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

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

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

Instance Attribute Details

#hostString

[Required] The host portion of the redirect.

Returns:

  • (String)


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

def host
  @host
end

#pathString

[Required] The path component of the target URL (e.g., "/path/to/resource" in "target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying, or request-prefixing. Use of \ is not permitted except to escape a following , {, or }. An empty value is treated the same as static "/". A static value must begin with a leading "/", optionally followed by other path characters. A request-copying value must exactly match "#path", and will be replaced with the path component of the request URL (including its initial "/"). A request-prefixing value must start with "/" and end with a non-escaped "#path", which will be replaced with the path component of the request URL (including its initial "/"). Only one such replacement token is allowed.

Returns:

  • (String)


31
32
33
# File 'lib/oci/waas/models/http_redirect_target.rb', line 31

def path
  @path
end

#portInteger

Port number of the target destination of the redirect, default to match protocol

Returns:

  • (Integer)


27
28
29
# File 'lib/oci/waas/models/http_redirect_target.rb', line 27

def port
  @port
end

#protocolString

[Required] The protocol used for the target, http or https.

Returns:

  • (String)


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

def protocol
  @protocol
end

#queryString

[Required] The query component of the target URL (e.g., "?redirected" in "target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying. Use of \ is not permitted except to escape a following , {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading "?", optionally followed by other query characters. A request-copying value must exactly match "#query", and will be replaced with the query component of the request URL (including a leading "?" if and only if the request URL includes a query component).

Returns:

  • (String)


35
36
37
# File 'lib/oci/waas/models/http_redirect_target.rb', line 35

def query
  @query
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'protocol',
    'host': :'host',
    'port': :'port',
    'path': :'path',
    'query': :'query'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
# File 'lib/oci/waas/models/http_redirect_target.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'String',
    'host': :'String',
    'port': :'Integer',
    'path': :'String',
    'query': :'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



111
112
113
114
115
116
117
118
119
120
# File 'lib/oci/waas/models/http_redirect_target.rb', line 111

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

  self.class == other.class &&
    protocol == other.protocol &&
    host == other.host &&
    port == other.port &&
    path == other.path &&
    query == other.query
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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/oci/waas/models/http_redirect_target.rb', line 145

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


125
126
127
# File 'lib/oci/waas/models/http_redirect_target.rb', line 125

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



134
135
136
# File 'lib/oci/waas/models/http_redirect_target.rb', line 134

def hash
  [protocol, host, port, path, query].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
# File 'lib/oci/waas/models/http_redirect_target.rb', line 178

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



172
173
174
# File 'lib/oci/waas/models/http_redirect_target.rb', line 172

def to_s
  to_hash.to_s
end