Class: OCI::Opensearch::Models::MaintenanceNotificationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/maintenance_notification_details.rb

Overview

Notification details for the maintenance activity.

Constant Summary collapse

MAINTENANCE_NOTIFICATION_TYPE_ENUM = 
[
  MAINTENANCE_NOTIFICATION_TYPE_SCHEDULED_MAINTENANCE_WITH_RELEASE_NOTES = 'SCHEDULED_MAINTENANCE_WITH_RELEASE_NOTES'.freeze,
  MAINTENANCE_NOTIFICATION_TYPE_SCHEDULED_MAINTENANCE_WITHOUT_RELEASE_NOTES = 'SCHEDULED_MAINTENANCE_WITHOUT_RELEASE_NOTES'.freeze,
  MAINTENANCE_NOTIFICATION_TYPE_RESCHEDULED_MAINTENANCE = 'RESCHEDULED_MAINTENANCE'.freeze,
  MAINTENANCE_NOTIFICATION_TYPE_SCHEDULED_MAINTENANCE_REMINDER = 'SCHEDULED_MAINTENANCE_REMINDER'.freeze,
  MAINTENANCE_NOTIFICATION_TYPE_SCHEDULED_MAINTENANCE_COMPLETED = 'SCHEDULED_MAINTENANCE_COMPLETED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MaintenanceNotificationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :jira_ticket (String) —

    The value to assign to the #jira_ticket property

  • :maintenance_notification_type (String) —

    The value to assign to the #maintenance_notification_type property

  • :tenant_ids (Array<String>) —

    The value to assign to the #tenant_ids property

  • :cluster_ids (Array<String>) —

    The value to assign to the #cluster_ids property

  • :start_time (String) —

    The value to assign to the #start_time property

  • :end_time (String) —

    The value to assign to the #end_time property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 83

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

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

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

  self.maintenance_notification_type = attributes[:'maintenanceNotificationType'] if attributes[:'maintenanceNotificationType']

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

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

  self.tenant_ids = attributes[:'tenantIds'] if attributes[:'tenantIds']

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

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

  self.cluster_ids = attributes[:'clusterIds'] if attributes[:'clusterIds']

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

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

  self.start_time = attributes[:'startTime'] if attributes[:'startTime']

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

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

  self.end_time = attributes[:'endTime'] if attributes[:'endTime']

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

  self.end_time = attributes[:'end_time'] if attributes[:'end_time']
end

Instance Attribute Details

#cluster_ids ⇒ Array<String>

List of OpenSearch clusterIds where we need to send the maintenance notifications

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 33

def cluster_ids
  @cluster_ids
end

#end_time ⇒ String

Start time for the notification activity in UTC like "2023-20-04 04:00:00.000Z"

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 41

def end_time
  @end_time
end

#jira_ticket ⇒ String

[Required] Jira tickets for on-call engineer to send customer notification

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 21

def jira_ticket
  @jira_ticket
end

#maintenance_notification_type ⇒ String

[Required] Maintenance Notification type

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 25

def maintenance_notification_type
  @maintenance_notification_type
end

#start_time ⇒ String

Start time for the notification activity in UTC like "2023-20-04 04:00:00.000Z"

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 37

def start_time
  @start_time
end

#tenant_ids ⇒ Array<String>

List of tenantIds where we need to send the maintenance notifications

Returns:

  • (Array<String>) 


29
30
31
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 29

def tenant_ids
  @tenant_ids
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'jira_ticket': :'jiraTicket',
    'maintenance_notification_type': :'maintenanceNotificationType',
    'tenant_ids': :'tenantIds',
    'cluster_ids': :'clusterIds',
    'start_time': :'startTime',
    'end_time': :'endTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'jira_ticket': :'String',
    'maintenance_notification_type': :'String',
    'tenant_ids': :'Array<String>',
    'cluster_ids': :'Array<String>',
    'start_time': :'String',
    'end_time': :'String'
    # 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



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 141

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

  self.class == other.class &&
    jira_ticket == other.jira_ticket &&
    maintenance_notification_type == other.maintenance_notification_type &&
    tenant_ids == other.tenant_ids &&
    cluster_ids == other.cluster_ids &&
    start_time == other.start_time &&
    end_time == other.end_time
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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 176

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


156
157
158
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 165

def hash
  [jira_ticket, maintenance_notification_type, tenant_ids, cluster_ids, start_time, end_time].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 209

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



203
204
205
 
# File 'lib/oci/opensearch/models/maintenance_notification_details.rb', line 203

def to_s
  to_hash.to_s
end