Class: OCI::VnMonitoring::Models::CaptureFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vn_monitoring/models/capture_filter.rb

Overview

A capture filter contains a set of capture_filter_rule_details governing what traffic a Vtap mirrors. The capture filter is created with no rules defined, and it must have at least one rule for the VTAP to start mirroring traffic.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
FILTER_TYPE_ENUM = 
[
  FILTER_TYPE_VTAP = 'VTAP'.freeze,
  FILTER_TYPE_FLOWLOG = 'FLOWLOG'.freeze,
  FILTER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CaptureFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 134

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.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']

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

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

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

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

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

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

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

  self.flow_log_capture_filter_rules = attributes[:'flowLogCaptureFilterRules'] if attributes[:'flowLogCaptureFilterRules']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the capture filter.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 32

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


38
39
40
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 38

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 44

def display_name
  @display_name
end

#filter_type ⇒ String

Indicates which service will use this capture filter

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 63

def filter_type
  @filter_type
end

#flow_log_capture_filter_rules ⇒ Array<OCI::VnMonitoring::Models::FlowLogCaptureFilterRuleDetails>

The set of rules governing what traffic the Flow Log collects when creating a flow log capture filter.

Returns:



80
81
82
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 80

def flow_log_capture_filter_rules
  @flow_log_capture_filter_rules
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


50
51
52
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 50

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The capture filter's Oracle ID (OCID).

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 55

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The capture filter's current administrative state.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the capture filter was created, in the format defined by RFC3339.

Example: 2021-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 70

def time_created
  @time_created
end

#vtap_capture_filter_rules ⇒ Array<OCI::VnMonitoring::Models::VtapCaptureFilterRuleDetails>

The set of rules governing what traffic a VTAP mirrors.

Returns:



75
76
77
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 75

def vtap_capture_filter_rules
  @vtap_capture_filter_rules
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'filter_type': :'filterType',
    'time_created': :'timeCreated',
    'vtap_capture_filter_rules': :'vtapCaptureFilterRules',
    'flow_log_capture_filter_rules': :'flowLogCaptureFilterRules'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'lifecycle_state': :'String',
    'filter_type': :'String',
    'time_created': :'DateTime',
    'vtap_capture_filter_rules': :'Array<OCI::VnMonitoring::Models::VtapCaptureFilterRuleDetails>',
    'flow_log_capture_filter_rules': :'Array<OCI::VnMonitoring::Models::FlowLogCaptureFilterRuleDetails>'
    # 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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 230

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    filter_type == other.filter_type &&
    time_created == other.time_created &&
    vtap_capture_filter_rules == other.vtap_capture_filter_rules &&
    flow_log_capture_filter_rules == other.flow_log_capture_filter_rules
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 269

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


249
250
251
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 249

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



258
259
260
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 258

def hash
  [compartment_id, defined_tags, display_name, freeform_tags, id, lifecycle_state, filter_type, time_created, vtap_capture_filter_rules, flow_log_capture_filter_rules].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 302

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



296
297
298
 
# File 'lib/oci/vn_monitoring/models/capture_filter.rb', line 296

def to_s
  to_hash.to_s
end