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):



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
 
# File 'lib/oci/waas/models/waas_policy.rb', line 133

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.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 for this web application.

Returns:

  • (Array<String>) 


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

def additional_domains
  @additional_domains
end

#cname ⇒ String

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

Returns:

  • (String) 


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

def cname
  @cname
end

#compartment_id ⇒ String

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the WAAS policy’s compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

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

A key-value pair with a defined schema that restricts the values of tags. These predefined keys are scoped to namespaces.

Returns:

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


70
71
72
 
# File 'lib/oci/waas/models/waas_policy.rb', line 70

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#domain ⇒ String

The web application domain that the WAAS policy protects.

Returns:

  • (String) 


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

def domain
  @domain
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair without any defined schema.

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the WAAS policy.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

The current lifecycle state of the WAAS policy.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#origins ⇒ Hash<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:



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

def origins
  @origins
end

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

Returns:



59
60
61
 
# File 'lib/oci/waas/models/waas_policy.rb', line 59

def policy_config
  @policy_config
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

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

Returns:



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

def waf_config
  @waf_config
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    'policy_config': :'policyConfig',
    'waf_config': :'wafConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/waas/models/waas_policy.rb', line 94

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>',
    '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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/waas/models/waas_policy.rb', line 222

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 &&
    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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/waas/models/waas_policy.rb', line 264

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


244
245
246
 
# File 'lib/oci/waas/models/waas_policy.rb', line 244

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/oci/waas/models/waas_policy.rb', line 253

def hash
  [id, compartment_id, display_name, domain, additional_domains, cname, lifecycle_state, time_created, 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



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/waas/models/waas_policy.rb', line 297

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



291
292
293
 
# File 'lib/oci/waas/models/waas_policy.rb', line 291

def to_s
  to_hash.to_s
end