Class: OCI::Waas::Models::CreateWaasPolicyDetails

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

Overview

The required data to create 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 = {}) ⇒ CreateWaasPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 110

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.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.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_domains ⇒ Array<String>

An array of additional domains for the specified web application.

Returns:

  • (Array<String>) 


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

def additional_domains
  @additional_domains
end

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which to create the WAAS policy.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
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).

Example: ‘{"CostCenter": "42"}`

Returns:

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#domain ⇒ String

[Required] The web application domain that the WAAS policy protects.

Returns:

  • (String) 


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

def domain
  @domain
end

#freeform_tags ⇒ Hash<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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#origin_groups ⇒ Hash<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. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request.

Returns:



34
35
36
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 34

def origin_groups
  @origin_groups
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:



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

def origins
  @origins
end

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

Returns:



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

def policy_config
  @policy_config
end

#waf_config ⇒ OCI::Waas::Models::WafConfigDetails

Returns:



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

def waf_config
  @waf_config
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 59

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

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'domain': :'String',
    'additional_domains': :'Array<String>',
    '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::WafConfigDetails',
    '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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 176

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    domain == other.domain &&
    additional_domains == other.additional_domains &&
    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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 215

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 204

def hash
  [compartment_id, display_name, domain, additional_domains, origins, origin_groups, 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



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 248

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



242
243
244
 
# File 'lib/oci/waas/models/create_waas_policy_details.rb', line 242

def to_s
  to_hash.to_s
end