Class: OCI::CloudGuard::Models::CreateDataSourceDetails

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

Overview

Parameters for creating a data source (DataSource resource).

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ENABLED = 'ENABLED'.freeze,
  STATUS_DISABLED = 'DISABLED'.freeze
].freeze
DATA_SOURCE_FEED_PROVIDER_ENUM = 
[
  DATA_SOURCE_FEED_PROVIDER_LOGGINGQUERY = 'LOGGINGQUERY'.freeze,
  DATA_SOURCE_FEED_PROVIDER_SCHEDULEDQUERY = 'SCHEDULEDQUERY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDataSourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



97
98
99
100
101
102
103
104
105
106
107
108
109
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
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 97

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.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.status = attributes[:'status'] if attributes[:'status']
  self.status = "DISABLED" if status.nil? && !attributes.key?(:'status') # rubocop:disable Style/StringLiterals

  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_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.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.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

#compartment_id ⇒ String

[Required] Compartment OCID of the data source

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 31

def compartment_id
  @compartment_id
end

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

Returns:



38
39
40
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 38

def data_source_details
  @data_source_details
end

#data_source_feed_provider ⇒ String

[Required] Type of data source feed provider (LoggingQuery)

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 35

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Data source display name

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 23

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


46
47
48
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 46

def freeform_tags
  @freeform_tags
end

#status ⇒ String

Enablement status of data source.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 27

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'status': :'status',
    'compartment_id': :'compartmentId',
    'data_source_feed_provider': :'dataSourceFeedProvider',
    'data_source_details': :'dataSourceDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'status': :'String',
    'compartment_id': :'String',
    'data_source_feed_provider': :'String',
    'data_source_details': :'OCI::CloudGuard::Models::DataSourceDetails',
    '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



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 166

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

  self.class == other.class &&
    display_name == other.display_name &&
    status == other.status &&
    compartment_id == other.compartment_id &&
    data_source_feed_provider == other.data_source_feed_provider &&
    data_source_details == other.data_source_details &&
    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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 202

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


182
183
184
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 191

def hash
  [display_name, status, compartment_id, data_source_feed_provider, data_source_details, 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



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 235

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



229
230
231
 
# File 'lib/oci/cloud_guard/models/create_data_source_details.rb', line 229

def to_s
  to_hash.to_s
end