Class: OCI::StackMonitoring::Models::MonitoredResourceTask

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/monitored_resource_task.rb

Overview

The request details for importing resources from Telemetry.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ MonitoredResourceTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :type (String) —

    The value to assign to the #type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :tenant_id (String) —

    The value to assign to the #tenant_id property

  • :task_details (OCI::StackMonitoring::Models::MonitoredResourceTaskDetails) —

    The value to assign to the #task_details property

  • :work_request_ids (Array<String>) —

    The value to assign to the #work_request_ids property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 150

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

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

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

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

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

  self.task_details = attributes[:'taskDetails'] if attributes[:'taskDetails']

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

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

  self.work_request_ids = attributes[:'workRequestIds'] if attributes[:'workRequestIds']

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

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

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

  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] The OCID of the compartment identifier.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 39

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


81
82
83
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 81

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


75
76
77
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 75

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Task identifier OCID.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 26

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the stack monitoring resource task.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] Name of the task.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 30

def name
  @name
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


87
88
89
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 87

def system_tags
  @system_tags
end

#task_details ⇒ OCI::StackMonitoring::Models::MonitoredResourceTaskDetails

This attribute is required.

Returns:



48
49
50
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 48

def task_details
  @task_details
end

#tenant_id ⇒ String

The OCID of the tenancy.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 44

def tenant_id
  @tenant_id
end

#time_created ⇒ DateTime

The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 59

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 65

def time_updated
  @time_updated
end

#type ⇒ String

Type of the task.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 34

def type
  @type
end

#work_request_ids ⇒ Array<String>

Identifiers OCID for work requests submitted for this task.

Returns:

  • (Array<String>) 


53
54
55
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 53

def work_request_ids
  @work_request_ids
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 90

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'tenant_id': :'tenantId',
    'task_details': :'taskDetails',
    'work_request_ids': :'workRequestIds',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 111

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'tenant_id': :'String',
    'task_details': :'OCI::StackMonitoring::Models::MonitoredResourceTaskDetails',
    'work_request_ids': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    '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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 243

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    tenant_id == other.tenant_id &&
    task_details == other.task_details &&
    work_request_ids == other.work_request_ids &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 285

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


265
266
267
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 265

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



274
275
276
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 274

def hash
  [id, name, type, compartment_id, tenant_id, task_details, work_request_ids, time_created, time_updated, lifecycle_state, 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



318
319
320
321
322
323
324
325
326
327
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 318

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



312
313
314
 
# File 'lib/oci/stack_monitoring/models/monitored_resource_task.rb', line 312

def to_s
  to_hash.to_s
end