Class: OCI::FleetAppsManagement::Models::CreateMaintenanceWindowDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb

Overview

The information about the new MaintenanceWindow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMaintenanceWindowDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :is_outage (BOOLEAN) —

    The value to assign to the #is_outage property

  • :time_schedule_start (DateTime) —

    The value to assign to the #time_schedule_start property

  • :duration (String) —

    The value to assign to the #duration property

  • :is_recurring (BOOLEAN) —

    The value to assign to the #is_recurring property

  • :recurrences (String) —

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



120
121
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
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 120

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

  self.is_outage = attributes[:'isOutage'] unless attributes[:'isOutage'].nil?
  self.is_outage = false if is_outage.nil? && !attributes.key?(:'isOutage') # rubocop:disable Style/StringLiterals

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

  self.is_outage = attributes[:'is_outage'] unless attributes[:'is_outage'].nil?
  self.is_outage = false if is_outage.nil? && !attributes.key?(:'isOutage') && !attributes.key?(:'is_outage') # rubocop:disable Style/StringLiterals

  self.time_schedule_start = attributes[:'timeScheduleStart'] if attributes[:'timeScheduleStart']

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

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

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

  self.is_recurring = attributes[:'isRecurring'] unless attributes[:'isRecurring'].nil?
  self.is_recurring = false if is_recurring.nil? && !attributes.key?(:'isRecurring') # rubocop:disable Style/StringLiterals

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

  self.is_recurring = attributes[:'is_recurring'] unless attributes[:'is_recurring'].nil?
  self.is_recurring = false if is_recurring.nil? && !attributes.key?(:'isRecurring') && !attributes.key?(:'is_recurring') # rubocop:disable Style/StringLiterals

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

  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

[Required] Compartment OCID

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 13

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


66
67
68
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 66

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 21

def display_name
  @display_name
end

#duration ⇒ String

[Required] Duration of the maintenance window. Specify how long the maintenance window remains open.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 44

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


60
61
62
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 60

def freeform_tags
  @freeform_tags
end

#is_outage ⇒ BOOLEAN

Does the maintenenace window cause outage? An outage indicates whether a maintenance window can consider operations that require downtime. It means a period when the application is not accessible.

Returns:

  • (BOOLEAN) 


34
35
36
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 34

def is_outage
  @is_outage
end

#is_recurring ⇒ BOOLEAN

Is this a recurring maintenance window?

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 48

def is_recurring
  @is_recurring
end

#recurrences ⇒ String

Recurrence rule specification if maintenance window recurring. Specify the frequency of running the maintenance window.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 54

def recurrences
  @recurrences
end

#time_schedule_start ⇒ DateTime

[Required] Specify the date and time of the day that the maintenance window starts.

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 38

def time_schedule_start
  @time_schedule_start
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'is_outage': :'isOutage',
    'time_schedule_start': :'timeScheduleStart',
    'duration': :'duration',
    'is_recurring': :'isRecurring',
    'recurrences': :'recurrences',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'is_outage': :'BOOLEAN',
    'time_schedule_start': :'DateTime',
    'duration': :'String',
    'is_recurring': :'BOOLEAN',
    'recurrences': :'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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 186

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    is_outage == other.is_outage &&
    time_schedule_start == other.time_schedule_start &&
    duration == other.duration &&
    is_recurring == other.is_recurring &&
    recurrences == other.recurrences &&
    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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 225

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


205
206
207
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 205

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 214

def hash
  [compartment_id, display_name, description, is_outage, time_schedule_start, duration, is_recurring, recurrences, 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



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 258

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



252
253
254
 
# File 'lib/oci/fleet_apps_management/models/create_maintenance_window_details.rb', line 252

def to_s
  to_hash.to_s
end