Class: OCI::Waas::Models::PolicyConfig

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

Overview

The configuration details for the WAAS policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :certificate_id (String)

    The value to assign to the #certificate_id property

  • :is_https_enabled (BOOLEAN)

    The value to assign to the #is_https_enabled property

  • :is_https_forced (BOOLEAN)

    The value to assign to the #is_https_forced property



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/oci/waas/models/policy_config.rb', line 52

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

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

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

  self.is_https_enabled = attributes[:'isHttpsEnabled'] unless attributes[:'isHttpsEnabled'].nil?

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

  self.is_https_enabled = attributes[:'is_https_enabled'] unless attributes[:'is_https_enabled'].nil?

  self.is_https_forced = attributes[:'isHttpsForced'] unless attributes[:'isHttpsForced'].nil?

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

  self.is_https_forced = attributes[:'is_https_forced'] unless attributes[:'is_https_forced'].nil?
end

Instance Attribute Details

#certificate_idString

The OCID of the SSL certificate to use if HTTPS is supported.

Returns:

  • (String)


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

def certificate_id
  @certificate_id
end

#is_https_enabledBOOLEAN

Enable or disable HTTPS support. If true, a ‘certificateId` is required. If unspecified, defaults to `false`.

Returns:

  • (BOOLEAN)


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

def is_https_enabled
  @is_https_enabled
end

#is_https_forcedBOOLEAN

Force HTTP to HTTPS redirection. If unspecified, defaults to ‘false`.

Returns:

  • (BOOLEAN)


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

def is_https_forced
  @is_https_forced
end

Class Method Details

.attribute_mapObject

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



22
23
24
25
26
27
28
29
30
# File 'lib/oci/waas/models/policy_config.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_id': :'certificateId',
    'is_https_enabled': :'isHttpsEnabled',
    'is_https_forced': :'isHttpsForced'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



33
34
35
36
37
38
39
40
41
# File 'lib/oci/waas/models/policy_config.rb', line 33

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_id': :'String',
    'is_https_enabled': :'BOOLEAN',
    'is_https_forced': :'BOOLEAN'
    # 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



84
85
86
87
88
89
90
91
# File 'lib/oci/waas/models/policy_config.rb', line 84

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

  self.class == other.class &&
    certificate_id == other.certificate_id &&
    is_https_enabled == other.is_https_enabled &&
    is_https_forced == other.is_https_forced
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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/oci/waas/models/policy_config.rb', line 116

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


96
97
98
# File 'lib/oci/waas/models/policy_config.rb', line 96

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



105
106
107
# File 'lib/oci/waas/models/policy_config.rb', line 105

def hash
  [certificate_id, is_https_enabled, is_https_forced].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/waas/models/policy_config.rb', line 149

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



143
144
145
# File 'lib/oci/waas/models/policy_config.rb', line 143

def to_s
  to_hash.to_s
end