Class: OCI::Database::Models::SchedulingWindow

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

Overview

Details of a Scheduling Window.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SchedulingWindow

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/database/models/scheduling_window.rb', line 136

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

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

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

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

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

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

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

The OCID of the compartment.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database/models/scheduling_window.rb', line 29

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The user-friendly name for the Scheduling Window. The name does not need to be unique.

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Scheduling Window.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database/models/scheduling_window.rb', line 25

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#scheduling_policy_id ⇒ String

[Required] The OCID of the Scheduling Policy.

Returns:

  • (String) 


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

def scheduling_policy_id
  @scheduling_policy_id
end

#time_created ⇒ DateTime

The date and time the Scheduling Window was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_next_scheduling_window_starts ⇒ DateTime

The date and time of the next upcoming window associated within the schedulingWindow is planned to start.

Returns:

  • (DateTime) 


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

def time_next_scheduling_window_starts
  @time_next_scheduling_window_starts
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#window_preference ⇒ OCI::Database::Models::WindowPreferenceDetail

This attribute is required.

Returns:



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

def window_preference
  @window_preference
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/database/models/scheduling_window.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_next_scheduling_window_starts': :'timeNextSchedulingWindowStarts',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'window_preference': :'windowPreference',
    'scheduling_policy_id': :'schedulingPolicyId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/database/models/scheduling_window.rb', line 99

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/database/models/scheduling_window.rb', line 228

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_next_scheduling_window_starts == other.time_next_scheduling_window_starts &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    window_preference == other.window_preference &&
    scheduling_policy_id == other.scheduling_policy_id &&
    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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/database/models/scheduling_window.rb', line 269

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


249
250
251
 
# File 'lib/oci/database/models/scheduling_window.rb', line 249

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



258
259
260
 
# File 'lib/oci/database/models/scheduling_window.rb', line 258

def hash
  [id, compartment_id, display_name, time_next_scheduling_window_starts, lifecycle_state, lifecycle_details, time_created, time_updated, window_preference, scheduling_policy_id, 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



302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database/models/scheduling_window.rb', line 302

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



296
297
298
 
# File 'lib/oci/database/models/scheduling_window.rb', line 296

def to_s
  to_hash.to_s
end