Class: OCI::Database::Models::SchedulingPlan

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/scheduling_plan.rb

Overview

Details of a Scheduling Plan.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PLAN_INTENT_ENUM = 
[
  PLAN_INTENT_EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE = 'EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE'.freeze,
  PLAN_INTENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SERVICE_TYPE_ENUM = 
[
  SERVICE_TYPE_EXACC = 'EXACC'.freeze,
  SERVICE_TYPE_EXACS = 'EXACS'.freeze,
  SERVICE_TYPE_FPPPCS = 'FPPPCS'.freeze,
  SERVICE_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 = {}) ⇒ SchedulingPlan

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :scheduling_policy_id (String) —

    The value to assign to the #scheduling_policy_id property

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :is_using_recommended_scheduled_actions (BOOLEAN) —

    The value to assign to the #is_using_recommended_scheduled_actions property

  • :plan_intent (String) —

    The value to assign to the #plan_intent property

  • :estimated_time_in_mins (Integer) —

    The value to assign to the #estimated_time_in_mins property

  • :service_type (String) —

    The value to assign to the #service_type 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

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



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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 180

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

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

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

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

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

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

  self.resource_id = attributes[:'resource_id'] if attributes[:'resource_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.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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.is_using_recommended_scheduled_actions = attributes[:'isUsingRecommendedScheduledActions'] unless attributes[:'isUsingRecommendedScheduledActions'].nil?

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

  self.is_using_recommended_scheduled_actions = attributes[:'is_using_recommended_scheduled_actions'] unless attributes[:'is_using_recommended_scheduled_actions'].nil?

  self.plan_intent = attributes[:'planIntent'] if attributes[:'planIntent']

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

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

  self.estimated_time_in_mins = attributes[:'estimatedTimeInMins'] if attributes[:'estimatedTimeInMins']

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

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

  self.service_type = attributes[:'serviceType'] if attributes[:'serviceType']

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

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 42

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.

Returns:

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


102
103
104
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 102

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The display name of the Scheduling Plan.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 54

def display_name
  @display_name
end

#estimated_time_in_mins ⇒ Integer

The estimated time for the Scheduling Plan.

Returns:

  • (Integer) 


76
77
78
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 76

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


96
97
98
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 96

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Scheduling Plan.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 38

def id
  @id
end

#is_using_recommended_scheduled_actions ⇒ BOOLEAN

If true, recommended scheduled actions will be generated for the scheduling plan.

Returns:

  • (BOOLEAN) 


67
68
69
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 67

def is_using_recommended_scheduled_actions
  @is_using_recommended_scheduled_actions
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Scheduling Plan. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#plan_intent ⇒ String

The current intent the Scheduling Plan. Valid states is EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 72

def plan_intent
  @plan_intent
end

#resource_id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 50

def resource_id
  @resource_id
end

#scheduling_policy_id ⇒ String

[Required] The OCID of the Scheduling Policy.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 46

def scheduling_policy_id
  @scheduling_policy_id
end

#service_type ⇒ String

[Required] The service type of the Scheduling Plan.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 80

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

Returns:

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


108
109
110
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 108

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Scheduling Plan Resource was created.

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 84

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the Scheduling Plan Resource was updated.

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 88

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'scheduling_policy_id': :'schedulingPolicyId',
    'resource_id': :'resourceId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'is_using_recommended_scheduled_actions': :'isUsingRecommendedScheduledActions',
    'plan_intent': :'planIntent',
    'estimated_time_in_mins': :'estimatedTimeInMins',
    'service_type': :'serviceType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'scheduling_policy_id': :'String',
    'resource_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'is_using_recommended_scheduled_actions': :'BOOLEAN',
    'plan_intent': :'String',
    'estimated_time_in_mins': :'Integer',
    'service_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 322

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    scheduling_policy_id == other.scheduling_policy_id &&
    resource_id == other.resource_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    is_using_recommended_scheduled_actions == other.is_using_recommended_scheduled_actions &&
    plan_intent == other.plan_intent &&
    estimated_time_in_mins == other.estimated_time_in_mins &&
    service_type == other.service_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 367

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


347
348
349
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 347

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



356
357
358
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 356

def hash
  [id, compartment_id, scheduling_policy_id, resource_id, display_name, lifecycle_state, lifecycle_details, is_using_recommended_scheduled_actions, plan_intent, estimated_time_in_mins, service_type, time_created, time_updated, 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



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 400

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



394
395
396
 
# File 'lib/oci/database/models/scheduling_plan.rb', line 394

def to_s
  to_hash.to_s
end