Class: OCI::Waas::Models::WafTrafficDatum

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

Overview

A time series of traffic data for the Web Application Firewall configured for a policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WafTrafficDatum

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_observed (DateTime) —

    The value to assign to the #time_observed property

  • :time_range_in_seconds (Integer) —

    The value to assign to the #time_range_in_seconds property

  • :tenancy_id (String) —

    The value to assign to the #tenancy_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :waas_policy_id (String) —

    The value to assign to the #waas_policy_id property

  • :traffic_in_bytes (Integer) —

    The value to assign to the #traffic_in_bytes property

[View source]

75
76
77
78
79
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
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 75

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

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

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

  self.time_range_in_seconds = attributes[:'timeRangeInSeconds'] if attributes[:'timeRangeInSeconds']

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

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

  self.tenancy_id = attributes[:'tenancyId'] if attributes[:'tenancyId']

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

  self.tenancy_id = attributes[:'tenancy_id'] if attributes[:'tenancy_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.waas_policy_id = attributes[:'waasPolicyId'] if attributes[:'waasPolicyId']

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

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

  self.traffic_in_bytes = attributes[:'trafficInBytes'] if attributes[:'trafficInBytes']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The compartment OCID of the data.

Returns:

  • (String) 

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

def compartment_id
  @compartment_id
end

#tenancy_id ⇒ String

The tenancy OCID of the data.

Returns:

  • (String) 

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

def tenancy_id
  @tenancy_id
end

#time_observed ⇒ DateTime

The date and time the traffic was observed, rounded down to the start of the range, and expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 

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

def time_observed
  @time_observed
end

#time_range_in_seconds ⇒ Integer

The number of seconds this data covers.

Returns:

  • (Integer) 

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

def time_range_in_seconds
  @time_range_in_seconds
end

#traffic_in_bytes ⇒ Integer

Traffic in bytes.

Returns:

  • (Integer) 

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

def traffic_in_bytes
  @traffic_in_bytes
end

#waas_policy_id ⇒ String

The policy OCID of the data.

Returns:

  • (String) 

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

def waas_policy_id
  @waas_policy_id
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_observed': :'timeObserved',
    'time_range_in_seconds': :'timeRangeInSeconds',
    'tenancy_id': :'tenancyId',
    'compartment_id': :'compartmentId',
    'waas_policy_id': :'waasPolicyId',
    'traffic_in_bytes': :'trafficInBytes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_observed': :'DateTime',
    'time_range_in_seconds': :'Integer',
    'tenancy_id': :'String',
    'compartment_id': :'String',
    'waas_policy_id': :'String',
    'traffic_in_bytes': :'Integer'
    # 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

[View source]

125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 125

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

  self.class == other.class &&
    time_observed == other.time_observed &&
    time_range_in_seconds == other.time_range_in_seconds &&
    tenancy_id == other.tenancy_id &&
    compartment_id == other.compartment_id &&
    waas_policy_id == other.waas_policy_id &&
    traffic_in_bytes == other.traffic_in_bytes
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

[View source]

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 160

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
[View source]

140
141
142
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

149
150
151
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 149

def hash
  [time_observed, time_range_in_seconds, tenancy_id, compartment_id, waas_policy_id, traffic_in_bytes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 193

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

[View source]

187
188
189
 
# File 'lib/oci/waas/models/waf_traffic_datum.rb', line 187

def to_s
  to_hash.to_s
end