Class: OCI::CloudGuard::Models::CreateTargetDetails

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

Overview

The information about new Target.

Constant Summary collapse

TARGET_RESOURCE_TYPE_ENUM =
[
  TARGET_RESOURCE_TYPE_COMPARTMENT = 'COMPARTMENT'.freeze,
  TARGET_RESOURCE_TYPE_ERPCLOUD = 'ERPCLOUD'.freeze,
  TARGET_RESOURCE_TYPE_HCMCLOUD = 'HCMCLOUD'.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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTargetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



122
123
124
125
126
127
128
129
130
131
132
133
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
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 122

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

  self.target_resource_type = attributes[:'targetResourceType'] if attributes[:'targetResourceType']

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

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

  self.target_resource_id = attributes[:'targetResourceId'] if attributes[:'targetResourceId']

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

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

  self.target_detector_recipes = attributes[:'targetDetectorRecipes'] if attributes[:'targetDetectorRecipes']

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

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

  self.target_responder_recipes = attributes[:'targetResponderRecipes'] if attributes[:'targetResponderRecipes']

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

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

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

[Required] Compartment Identifier where the resource is created

Returns:

  • (String)


32
33
34
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 32

def compartment_id
  @compartment_id
end

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


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

def defined_tags
  @defined_tags
end

#descriptionString

The target description.

Returns:

  • (String)


36
37
38
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 36

def description
  @description
end

#display_nameString

[Required] DetectorTemplate Identifier

Returns:

  • (String)


28
29
30
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 28

def display_name
  @display_name
end

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


62
63
64
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 62

def freeform_tags
  @freeform_tags
end

#lifecycle_stateString

The current state of the DetectorRule.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#target_detector_recipesArray<OCI::CloudGuard::Models::CreateTargetDetectorRecipeDetails>

List of detector recipes to associate with target



48
49
50
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 48

def target_detector_recipes
  @target_detector_recipes
end

#target_resource_idString

[Required] Resource ID which the target uses to monitor

Returns:

  • (String)


44
45
46
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 44

def target_resource_id
  @target_resource_id
end

#target_resource_typeString

[Required] possible type of targets(compartment/HCMCloud/ERPCloud)

Returns:

  • (String)


40
41
42
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 40

def target_resource_type
  @target_resource_type
end

#target_responder_recipesArray<OCI::CloudGuard::Models::CreateTargetResponderRecipeDetails>

List of responder recipes to associate with target



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

def target_responder_recipes
  @target_responder_recipes
end

Class Method Details

.attribute_mapObject

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'target_resource_type': :'targetResourceType',
    'target_resource_id': :'targetResourceId',
    'target_detector_recipes': :'targetDetectorRecipes',
    'target_responder_recipes': :'targetResponderRecipes',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'target_resource_type': :'String',
    'target_resource_id': :'String',
    'target_detector_recipes': :'Array<OCI::CloudGuard::Models::CreateTargetDetectorRecipeDetails>',
    'target_responder_recipes': :'Array<OCI::CloudGuard::Models::CreateTargetResponderRecipeDetails>',
    'lifecycle_state': :'String',
    '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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 208

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    target_resource_type == other.target_resource_type &&
    target_resource_id == other.target_resource_id &&
    target_detector_recipes == other.target_detector_recipes &&
    target_responder_recipes == other.target_responder_recipes &&
    lifecycle_state == other.lifecycle_state &&
    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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 247

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


227
228
229
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 227

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



236
237
238
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 236

def hash
  [display_name, compartment_id, description, target_resource_type, target_resource_id, target_detector_recipes, target_responder_recipes, lifecycle_state, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 280

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



274
275
276
# File 'lib/oci/cloud_guard/models/create_target_details.rb', line 274

def to_s
  to_hash.to_s
end