Class: OCI::CloudGuard::Models::DataSource

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/data_source.rb

Overview

Detailed information for a data source (DataSource resource).

Constant Summary collapse

DATA_SOURCE_FEED_PROVIDER_ENUM = 
[
  DATA_SOURCE_FEED_PROVIDER_LOGGINGQUERY = 'LOGGINGQUERY'.freeze,
  DATA_SOURCE_FEED_PROVIDER_SCHEDULEDQUERY = 'SCHEDULEDQUERY'.freeze,
  DATA_SOURCE_FEED_PROVIDER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ DataSource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 172

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

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

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

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

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

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

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

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

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

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

  self.data_source_detector_mapping_info = attributes[:'dataSourceDetectorMappingInfo'] if attributes[:'dataSourceDetectorMappingInfo']

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

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

  self.region_status_detail = attributes[:'regionStatusDetail'] if attributes[:'regionStatusDetail']

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

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment OCID of data source

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 49

def compartment_id
  @compartment_id
end

#data_source_details ⇒ OCI::CloudGuard::Models::DataSourceDetails

Returns:



52
53
54
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 52

def data_source_details
  @data_source_details
end

#data_source_detector_mapping_info ⇒ Array<OCI::CloudGuard::Models::DataSourceMappingInfo>

Information about the detector recipe and rule attached

Returns:



68
69
70
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 68

def data_source_detector_mapping_info
  @data_source_detector_mapping_info
end

#data_source_feed_provider ⇒ String

[Required] Possible type of dataSourceFeed Provider(LoggingQuery)

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 45

def data_source_feed_provider
  @data_source_feed_provider
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>>) 


94
95
96
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 94

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Display name of the data source

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 41

def display_name
  @display_name
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\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


88
89
90
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 88

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID for the data source

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 37

def id
  @id
end

#lifecycle_state ⇒ String

The current lifecycle state of the resource.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::CloudGuard::Models::ResourceLock>

Locks associated with this resource.

Returns:



80
81
82
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 80

def locks
  @locks
end

#region_status_detail ⇒ Array<OCI::CloudGuard::Models::RegionStatusDetail>

Information about the region and status of query replication

Returns:



72
73
74
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 72

def region_status_detail
  @region_status_detail
end

#status ⇒ String

Enablement status of the data source

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 64

def status
  @status
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


103
104
105
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 103

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the Data source was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 56

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the data source was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 60

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'data_source_feed_provider': :'dataSourceFeedProvider',
    'compartment_id': :'compartmentId',
    'data_source_details': :'dataSourceDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'status': :'status',
    'data_source_detector_mapping_info': :'dataSourceDetectorMappingInfo',
    'region_status_detail': :'regionStatusDetail',
    'lifecycle_state': :'lifecycleState',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 129

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'data_source_feed_provider': :'String',
    'compartment_id': :'String',
    'data_source_details': :'OCI::CloudGuard::Models::DataSourceDetails',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'status': :'String',
    'data_source_detector_mapping_info': :'Array<OCI::CloudGuard::Models::DataSourceMappingInfo>',
    'region_status_detail': :'Array<OCI::CloudGuard::Models::RegionStatusDetail>',
    'lifecycle_state': :'String',
    'locks': :'Array<OCI::CloudGuard::Models::ResourceLock>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 303

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    data_source_feed_provider == other.data_source_feed_provider &&
    compartment_id == other.compartment_id &&
    data_source_details == other.data_source_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    status == other.status &&
    data_source_detector_mapping_info == other.data_source_detector_mapping_info &&
    region_status_detail == other.region_status_detail &&
    lifecycle_state == other.lifecycle_state &&
    locks == other.locks &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 347

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


327
328
329
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 327

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



336
337
338
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 336

def hash
  [id, display_name, data_source_feed_provider, compartment_id, data_source_details, time_created, time_updated, status, data_source_detector_mapping_info, region_status_detail, lifecycle_state, locks, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 380

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



374
375
376
 
# File 'lib/oci/cloud_guard/models/data_source.rb', line 374

def to_s
  to_hash.to_s
end