Class: OCI::Database::Models::SchedulingPolicySummary

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

Overview

Details of a Scheduling Policy.

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
CADENCE_ENUM = 
[
  CADENCE_HALFYEARLY = 'HALFYEARLY'.freeze,
  CADENCE_QUARTERLY = 'QUARTERLY'.freeze,
  CADENCE_MONTHLY = 'MONTHLY'.freeze,
  CADENCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SchedulingPolicySummary

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

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

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :cadence (String) —

    The value to assign to the #cadence property

  • :cadence_start_month (OCI::Database::Models::Month) —

    The value to assign to the #cadence_start_month property

  • :time_next_window_starts (DateTime) —

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



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
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
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 144

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

  self.cadence_start_month = attributes[:'cadenceStartMonth'] if attributes[:'cadenceStartMonth']

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

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

  self.time_next_window_starts = attributes[:'timeNextWindowStarts'] if attributes[:'timeNextWindowStarts']

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

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

  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

#cadence ⇒ String

[Required] The cadence period.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 62

def cadence
  @cadence
end

#cadence_start_month ⇒ OCI::Database::Models::Month

Start of the month to be followed during the cadence period.

Returns:



66
67
68
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 66

def cadence_start_month
  @cadence_start_month
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 37

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the Scheduling Policy. The name does not need to be unique.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 41

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


78
79
80
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 78

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Scheduling Policy.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 33

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the Scheduling Policy was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_next_window_starts ⇒ DateTime

The date and time of the next scheduling window associated with the schedulingPolicy is planned to start.

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 70

def time_next_window_starts
  @time_next_window_starts
end

#time_updated ⇒ DateTime

The last date and time that the Scheduling Policy was updated.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 58

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'cadence': :'cadence',
    'cadence_start_month': :'cadenceStartMonth',
    'time_next_window_starts': :'timeNextWindowStarts',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'cadence': :'String',
    'cadence_start_month': :'OCI::Database::Models::Month',
    'time_next_window_starts': :'DateTime',
    '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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 248

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    cadence == other.cadence &&
    cadence_start_month == other.cadence_start_month &&
    time_next_window_starts == other.time_next_window_starts &&
    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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 289

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


269
270
271
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 269

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 278

def hash
  [id, compartment_id, display_name, lifecycle_state, lifecycle_details, time_created, time_updated, cadence, cadence_start_month, time_next_window_starts, 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



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 322

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



316
317
318
 
# File 'lib/oci/database/models/scheduling_policy_summary.rb', line 316

def to_s
  to_hash.to_s
end