datadog_api_client 1.7.0 → 1.8.0

data/lib/datadog_api_client/v1/models/downtime_child.rb

@@ -5,7 +5,7 @@
 
 The version of the OpenAPI document: 1.0
 Contact: support@datadoghq.com
-Generated by: https://openapi-generator.tech
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
 
  Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
  This product includes software developed at Datadog (https://www.datadoghq.com/).
@@ -17,8 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # The downtime object definition of the active child for the original parent recurring downtime. This field will only exist on recurring downtimes.
+  # The downtime object definition of the active child for the original parent recurring downtime. This
+  # field will only exist on recurring downtimes.
   class DowntimeChild
+    include BaseGenericModel
+
     # Whether the object has unparsed attributes
     # @!visibility private
     attr_accessor :_unparsed
@@ -35,33 +38,45 @@ module DatadogAPIClient::V1
     # If a downtime has been disabled.
     attr_accessor :disabled
 
-    # `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts.
+    # `0` for a downtime applied on `*` or all,
+    # `1` when the downtime is only scoped to hosts,
+    # or `2` when the downtime is scoped to anything but hosts.
     attr_accessor :downtime_type
 
-    # POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it.
+    # POSIX timestamp to end the downtime. If not provided,
+    # the downtime is in effect indefinitely until you cancel it.
     attr_accessor :_end
 
     # The downtime ID.
     attr_accessor :id
 
-    # A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events.
+    # A message to include with notifications for this downtime.
+    # Email notifications can be sent to specific users by using the same `@username` notation as events.
     attr_accessor :message
 
-    # A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors.
+    # A single monitor to which the downtime applies.
+    # If not provided, the downtime applies to all monitors.
     attr_accessor :monitor_id
 
-    # A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`.
+    # A comma-separated list of monitor tags. For example, tags that are applied directly to monitors,
+    # not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.
+    # The resulting downtime applies to monitors that match ALL provided monitor tags.
+    # For example, `service:postgres` **AND** `team:frontend`.
     attr_accessor :monitor_tags
 
     # ID of the parent Downtime.
     attr_accessor :parent_id
 
+    # An object defining the recurrence of the downtime.
     attr_accessor :recurrence
 
-    # The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
+    # The scope(s) to which the downtime applies. For example, `host:app2`.
+    # Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
+    # The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
     attr_accessor :scope
 
-    # POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created.
+    # POSIX timestamp to start the downtime.
+    # If not provided, the downtime starts the moment it is created.
     attr_accessor :start
 
     # The timezone in which to display the downtime's start and end times in Datadog applications.
@@ -131,12 +146,13 @@ module DatadogAPIClient::V1
         :'monitor_id',
         :'parent_id',
         :'recurrence',
-        :'updater_id'
+        :'updater_id',
       ])
     end
 
     # Initializes the object
-    # @param attributes [Hash] attributes Model attributes in the form of hash
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
         fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::DowntimeChild` initialize method"
@@ -220,22 +236,19 @@ module DatadogAPIClient::V1
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @!visibility private
     # @return Array for valid properties with the reasons
+    # @!visibility private
     def list_invalid_properties
       invalid_properties = Array.new
       if !@creator_id.nil? && @creator_id > 2147483647
         invalid_properties.push('invalid value for "creator_id", must be smaller than or equal to 2147483647.')
       end
-
       if !@downtime_type.nil? && @downtime_type > 2147483647
         invalid_properties.push('invalid value for "downtime_type", must be smaller than or equal to 2147483647.')
       end
-
       if !@updater_id.nil? && @updater_id > 2147483647
         invalid_properties.push('invalid value for "updater_id", must be smaller than or equal to 2147483647.')
       end
-
       invalid_properties
     end
 
@@ -250,32 +263,32 @@ module DatadogAPIClient::V1
     end
 
     # Custom attribute writer method with validation
-    # @param creator_id [Object] creator_id Value to be assigned
+    # @param creator_id [Object] Object to be assigned
+    # @!visibility private
     def creator_id=(creator_id)
       if !creator_id.nil? && creator_id > 2147483647
         fail ArgumentError, 'invalid value for "creator_id", must be smaller than or equal to 2147483647.'
       end
-
       @creator_id = creator_id
     end
 
     # Custom attribute writer method with validation
-    # @param downtime_type [Object] downtime_type Value to be assigned
+    # @param downtime_type [Object] Object to be assigned
+    # @!visibility private
     def downtime_type=(downtime_type)
       if !downtime_type.nil? && downtime_type > 2147483647
         fail ArgumentError, 'invalid value for "downtime_type", must be smaller than or equal to 2147483647.'
       end
-
       @downtime_type = downtime_type
     end
 
     # Custom attribute writer method with validation
-    # @param updater_id [Object] updater_id Value to be assigned
+    # @param updater_id [Object] Object to be assigned
+    # @!visibility private
     def updater_id=(updater_id)
       if !updater_id.nil? && updater_id > 2147483647
         fail ArgumentError, 'invalid value for "updater_id", must be smaller than or equal to 2147483647.'
       end
-
       @updater_id = updater_id
     end
 
@@ -316,139 +329,5 @@ module DatadogAPIClient::V1
     def hash
       [active, canceled, creator_id, disabled, downtime_type, _end, id, message, monitor_id, monitor_tags, parent_id, recurrence, scope, start, timezone, updater_id].hash
     end
-
-    # Builds the object from hash
-    # @param attributes [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    # @!visibility private
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param attributes [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    # @!visibility private
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param type [string] Data type
-    # @param value [string] Value to be deserialized
-    # @return [Object] Deserialized data
-    # @!visibility private
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when :Array
-        # generic array, return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = DatadogAPIClient::V1.const_get(type)
-        res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-        if res.instance_of? DatadogAPIClient::V1::UnparsedObject
-          self._unparsed = true
-        end
-        res
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    # @!visibility private
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    # @!visibility private
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    # @!visibility private
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param value [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    # @!visibility private
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
-
 end

data/lib/datadog_api_client/v1/models/downtime_recurrence.rb

@@ -5,7 +5,7 @@
 
 The version of the OpenAPI document: 1.0
 Contact: support@datadoghq.com
-Generated by: https://openapi-generator.tech
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
 
  Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
  This product includes software developed at Datadog (https://www.datadoghq.com/).
@@ -19,26 +19,37 @@ require 'time'
 module DatadogAPIClient::V1
   # An object defining the recurrence of the downtime.
   class DowntimeRecurrence
+    include BaseGenericModel
+
     # Whether the object has unparsed attributes
     # @!visibility private
     attr_accessor :_unparsed
 
-    # How often to repeat as an integer. For example, to repeat every 3 days, select a type of `days` and a period of `3`.
+    # How often to repeat as an integer.
+    # For example, to repeat every 3 days, select a type of `days` and a period of `3`.
     attr_accessor :period
 
-    # The `RRULE` standard for defining recurring events (**requires to set \"type\" to rrule**) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.  **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api)
+    # The `RRULE` standard for defining recurring events (**requires to set "type" to rrule**)
+    # For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.
+    # Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.
+    #
+    # **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).
+    # More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api)
     attr_accessor :rrule
 
     # The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`.
     attr_accessor :type
 
-    # The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive.
+    # The date at which the recurrence should end as a POSIX timestamp.
+    # `until_occurences` and `until_date` are mutually exclusive.
     attr_accessor :until_date
 
-    # How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive.
+    # How many times the downtime is rescheduled.
+    # `until_occurences` and `until_date` are mutually exclusive.
     attr_accessor :until_occurrences
 
-    # A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized.
+    # A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`.
+    # Only applicable when type is weeks. First letter must be capitalized.
     attr_accessor :week_days
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -79,12 +90,13 @@ module DatadogAPIClient::V1
       Set.new([
         :'until_date',
         :'until_occurrences',
-        :'week_days'
+        :'week_days',
       ])
     end
 
     # Initializes the object
-    # @param attributes [Hash] attributes Model attributes in the form of hash
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
         fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::DowntimeRecurrence` initialize method"
@@ -126,18 +138,16 @@ module DatadogAPIClient::V1
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @!visibility private
     # @return Array for valid properties with the reasons
+    # @!visibility private
     def list_invalid_properties
       invalid_properties = Array.new
       if !@period.nil? && @period > 2147483647
         invalid_properties.push('invalid value for "period", must be smaller than or equal to 2147483647.')
       end
-
       if !@until_occurrences.nil? && @until_occurrences > 2147483647
         invalid_properties.push('invalid value for "until_occurrences", must be smaller than or equal to 2147483647.')
       end
-
       invalid_properties
     end
 
@@ -151,22 +161,22 @@ module DatadogAPIClient::V1
     end
 
     # Custom attribute writer method with validation
-    # @param period [Object] period Value to be assigned
+    # @param period [Object] Object to be assigned
+    # @!visibility private
     def period=(period)
       if !period.nil? && period > 2147483647
         fail ArgumentError, 'invalid value for "period", must be smaller than or equal to 2147483647.'
       end
-
       @period = period
     end
 
     # Custom attribute writer method with validation
-    # @param until_occurrences [Object] until_occurrences Value to be assigned
+    # @param until_occurrences [Object] Object to be assigned
+    # @!visibility private
     def until_occurrences=(until_occurrences)
       if !until_occurrences.nil? && until_occurrences > 2147483647
         fail ArgumentError, 'invalid value for "until_occurrences", must be smaller than or equal to 2147483647.'
       end
-
       @until_occurrences = until_occurrences
     end
 
@@ -197,139 +207,5 @@ module DatadogAPIClient::V1
     def hash
       [period, rrule, type, until_date, until_occurrences, week_days].hash
     end
-
-    # Builds the object from hash
-    # @param attributes [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    # @!visibility private
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param attributes [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    # @!visibility private
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param type [string] Data type
-    # @param value [string] Value to be deserialized
-    # @return [Object] Deserialized data
-    # @!visibility private
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when :Array
-        # generic array, return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = DatadogAPIClient::V1.const_get(type)
-        res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-        if res.instance_of? DatadogAPIClient::V1::UnparsedObject
-          self._unparsed = true
-        end
-        res
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    # @!visibility private
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    # @!visibility private
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    # @!visibility private
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param value [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    # @!visibility private
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
-
 end