Class: OCI::Waas::Models::WaasPolicy

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

Overview

The details of a Web Application Acceleration and Security (WAAS) policy. A policy describes how the WAAS service should operate for the configured web application.

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WaasPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/oci/waas/models/waas_policy.rb', line 149

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

  self.origin_groups = attributes[:'originGroups'] if attributes[:'originGroups']

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

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

  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_domainsArray<String>

An array of additional domains for this web application.

Returns:

  • (Array<String>)


41
42
43
# File 'lib/oci/waas/models/waas_policy.rb', line 41

def additional_domains
  @additional_domains
end

#cnameString

The CNAME record to add to your DNS configuration to route traffic for the domain, and all additional domains, through the WAF.

Returns:

  • (String)


45
46
47
# File 'lib/oci/waas/models/waas_policy.rb', line 45

def cname
  @cname
end

#compartment_idString

The OCID of the WAAS policy's compartment.

Returns:

  • (String)


29
30
31
# File 'lib/oci/waas/models/waas_policy.rb', line 29

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


83
84
85
# File 'lib/oci/waas/models/waas_policy.rb', line 83

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


33
34
35
# File 'lib/oci/waas/models/waas_policy.rb', line 33

def display_name
  @display_name
end

#domainString

The web application domain that the WAAS policy protects.

Returns:

  • (String)


37
38
39
# File 'lib/oci/waas/models/waas_policy.rb', line 37

def domain
  @domain
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


75
76
77
# File 'lib/oci/waas/models/waas_policy.rb', line 75

def freeform_tags
  @freeform_tags
end

#idString

The OCID of the WAAS policy.

Returns:

  • (String)


25
26
27
# File 'lib/oci/waas/models/waas_policy.rb', line 25

def id
  @id
end

#lifecycle_stateString

The current lifecycle state of the WAAS policy.

Returns:

  • (String)


49
50
51
# File 'lib/oci/waas/models/waas_policy.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#origin_groupsHash<String, OCI::Waas::Models::OriginGroup>

The map of origin groups and their keys used to associate origins to the wafConfig. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.

Returns:



61
62
63
# File 'lib/oci/waas/models/waas_policy.rb', line 61

def origin_groups
  @origin_groups
end

#originsHash<String, OCI::Waas::Models::Origin>

A map of host servers (origins) and their keys for the web application. Origin keys are used to associate origins to specific protection rules. The key should be a user-friendly name for the host. Examples: primary or secondary.

Returns:



57
58
59
# File 'lib/oci/waas/models/waas_policy.rb', line 57

def origins
  @origins
end

#policy_configOCI::Waas::Models::PolicyConfig



64
65
66
# File 'lib/oci/waas/models/waas_policy.rb', line 64

def policy_config
  @policy_config
end

#time_createdDateTime

The date and time the policy was created, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime)


53
54
55
# File 'lib/oci/waas/models/waas_policy.rb', line 53

def time_created
  @time_created
end

#waf_configOCI::Waas::Models::WafConfig



67
68
69
# File 'lib/oci/waas/models/waas_policy.rb', line 67

def waf_config
  @waf_config
end

Class Method Details

.attribute_mapObject

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/oci/waas/models/waas_policy.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'domain': :'domain',
    'additional_domains': :'additionalDomains',
    'cname': :'cname',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'origins': :'origins',
    'origin_groups': :'originGroups',
    'policy_config': :'policyConfig',
    'waf_config': :'wafConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'domain': :'String',
    'additional_domains': :'Array<String>',
    'cname': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'origins': :'Hash<String, OCI::Waas::Models::Origin>',
    'origin_groups': :'Hash<String, OCI::Waas::Models::OriginGroup>',
    '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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/oci/waas/models/waas_policy.rb', line 244

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    domain == other.domain &&
    additional_domains == other.additional_domains &&
    cname == other.cname &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    origins == other.origins &&
    origin_groups == other.origin_groups &&
    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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/oci/waas/models/waas_policy.rb', line 287

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


267
268
269
# File 'lib/oci/waas/models/waas_policy.rb', line 267

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



276
277
278
# File 'lib/oci/waas/models/waas_policy.rb', line 276

def hash
  [id, compartment_id, display_name, domain, additional_domains, cname, lifecycle_state, time_created, origins, origin_groups, policy_config, waf_config, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



320
321
322
323
324
325
326
327
328
329
# File 'lib/oci/waas/models/waas_policy.rb', line 320

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



314
315
316
# File 'lib/oci/waas/models/waas_policy.rb', line 314

def to_s
  to_hash.to_s
end