Class: OCI::Waas::Models::UpdateWaasPolicyDetails

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

Overview

Updates the configuration details of a WAAS policy.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateWaasPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 80

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

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

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

  self.additional_domains = attributes[:'additionalDomains'] if attributes[:'additionalDomains']

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

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

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

  self.policy_config = attributes[:'policyConfig'] if attributes[:'policyConfig']

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

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

  self.waf_config = attributes[:'wafConfig'] if attributes[:'wafConfig']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#additional_domains ⇒ Array<String>

An array of additional domains protected by this WAAS policy.

Returns:

  • (Array<String>) 


17
18
19
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 17

def additional_domains
  @additional_domains
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name for the WAAS policy. The name is can be changed and does not need to be unique.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair without any defined schema.

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#origins ⇒ Hash<String, OCI::Waas::Models::Origin>

A map of host to origin for the web application. The key should be a customer friendly name for the host, ex. primary, secondary, etc.

Returns:



21
22
23
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 21

def origins
  @origins
end

#policy_config ⇒ OCI::Waas::Models::PolicyConfig

Returns:



24
25
26
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 24

def policy_config
  @policy_config
end

#waf_config ⇒ OCI::Waas::Models::WafConfig

Returns:



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

def waf_config
  @waf_config
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'additional_domains': :'additionalDomains',
    'origins': :'origins',
    'policy_config': :'policyConfig',
    'waf_config': :'wafConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'additional_domains': :'Array<String>',
    'origins': :'Hash<String, OCI::Waas::Models::Origin>',
    'policy_config': :'OCI::Waas::Models::PolicyConfig',
    'waf_config': :'OCI::Waas::Models::WafConfig',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 132

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

  self.class == other.class &&
    display_name == other.display_name &&
    additional_domains == other.additional_domains &&
    origins == other.origins &&
    policy_config == other.policy_config &&
    waf_config == other.waf_config &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 168

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


148
149
150
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 157

def hash
  [display_name, additional_domains, origins, policy_config, waf_config, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 201

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



195
196
197
 
# File 'lib/oci/waas/models/update_waas_policy_details.rb', line 195

def to_s
  to_hash.to_s
end