Class: OCI::Core::Models::CaptureFilter

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

Overview

A capture filter contains a set of #capture_filter_rule_details capture_filter_rule_details} governing what traffic is mirrored for a Vtap or captured for a {VCN Flow Log. The capture filter is created with no rules defined, and it must have at least one rule to mirror traffic for the VTAP or collect VCN flow logs.

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



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/core/models/capture_filter.rb', line 139

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) 


33
34
35
 
# File 'lib/oci/core/models/capture_filter.rb', line 33

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.

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

Returns:

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


41
42
43
 
# File 'lib/oci/core/models/capture_filter.rb', line 41

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) 


47
48
49
 
# File 'lib/oci/core/models/capture_filter.rb', line 47

def display_name
  @display_name
end

#filter_type ⇒ String

Indicates which service will use this capture filter

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/core/models/capture_filter.rb', line 68

def filter_type
  @filter_type
end

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

The set of rules governing what traffic the VCN flow log collects.

Returns:



85
86
87
 
# File 'lib/oci/core/models/capture_filter.rb', line 85

def flow_log_capture_filter_rules
  @flow_log_capture_filter_rules
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.

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

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/core/models/capture_filter.rb', line 60

def id
  @id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/core/models/capture_filter.rb', line 64

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) 


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

def time_created
  @time_created
end

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

The set of rules governing what traffic a VTAP mirrors.

Returns:



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

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.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/core/models/capture_filter.rb', line 88

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.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/core/models/capture_filter.rb', line 106

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::Core::Models::VtapCaptureFilterRuleDetails>',
    'flow_log_capture_filter_rules': :'Array<OCI::Core::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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/core/models/capture_filter.rb', line 235

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/core/models/capture_filter.rb', line 274

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


254
255
256
 
# File 'lib/oci/core/models/capture_filter.rb', line 254

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/oci/core/models/capture_filter.rb', line 263

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



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/core/models/capture_filter.rb', line 307

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



301
302
303
 
# File 'lib/oci/core/models/capture_filter.rb', line 301

def to_s
  to_hash.to_s
end