datadog_api_client 2.12.0 → 2.14.0

data/lib/datadog_api_client/v2/models/downtime_update_request_attributes.rb

@@ -0,0 +1,165 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+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/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Attributes of the downtime to update.
+  class DowntimeUpdateRequestAttributes
+    include BaseGenericModel
+
+    # The timezone in which to display the downtime's start and end times in Datadog applications. This is not used
+    # as an offset for scheduling.
+    attr_accessor :display_timezone
+
+    # 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
+
+    # Monitor identifier for the downtime.
+    attr_accessor :monitor_identifier
+
+    # If the first recovery notification during a downtime should be muted.
+    attr_accessor :mute_first_recovery_notification
+
+    # States that will trigger a monitor notification when the `notify_end_types` action occurs.
+    attr_accessor :notify_end_states
+
+    # Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.
+    attr_accessor :notify_end_types
+
+    # Schedule for the downtime.
+    attr_accessor :schedule
+
+    # The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
+    attr_accessor :scope
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'display_timezone' => :'display_timezone',
+        :'message' => :'message',
+        :'monitor_identifier' => :'monitor_identifier',
+        :'mute_first_recovery_notification' => :'mute_first_recovery_notification',
+        :'notify_end_states' => :'notify_end_states',
+        :'notify_end_types' => :'notify_end_types',
+        :'schedule' => :'schedule',
+        :'scope' => :'scope'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'display_timezone' => :'String',
+        :'message' => :'String',
+        :'monitor_identifier' => :'DowntimeMonitorIdentifier',
+        :'mute_first_recovery_notification' => :'Boolean',
+        :'notify_end_states' => :'Array<DowntimeNotifyEndStateTypes>',
+        :'notify_end_types' => :'Array<DowntimeNotifyEndStateActions>',
+        :'schedule' => :'DowntimeScheduleUpdateRequest',
+        :'scope' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'display_timezone',
+        :'message',
+      ])
+    end
+
+    # Initializes the object
+    # @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::V2::DowntimeUpdateRequestAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::DowntimeUpdateRequestAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'display_timezone')
+        self.display_timezone = attributes[:'display_timezone']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'monitor_identifier')
+        self.monitor_identifier = attributes[:'monitor_identifier']
+      end
+
+      if attributes.key?(:'mute_first_recovery_notification')
+        self.mute_first_recovery_notification = attributes[:'mute_first_recovery_notification']
+      end
+
+      if attributes.key?(:'notify_end_states')
+        if (value = attributes[:'notify_end_states']).is_a?(Array)
+          self.notify_end_states = value
+        end
+      end
+
+      if attributes.key?(:'notify_end_types')
+        if (value = attributes[:'notify_end_types']).is_a?(Array)
+          self.notify_end_types = value
+        end
+      end
+
+      if attributes.key?(:'schedule')
+        self.schedule = attributes[:'schedule']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          display_timezone == o.display_timezone &&
+          message == o.message &&
+          monitor_identifier == o.monitor_identifier &&
+          mute_first_recovery_notification == o.mute_first_recovery_notification &&
+          notify_end_states == o.notify_end_states &&
+          notify_end_types == o.notify_end_types &&
+          schedule == o.schedule &&
+          scope == o.scope
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [display_timezone, message, monitor_identifier, mute_first_recovery_notification, notify_end_states, notify_end_types, schedule, scope].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/{team_data.rb → downtime_update_request_data.rb}

@@ -17,17 +17,17 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # A team
-  class TeamData
+  # Object to update a downtime.
+  class DowntimeUpdateRequestData
     include BaseGenericModel
 
-    # Team attributes
+    # Attributes of the downtime to update.
     attr_reader :attributes
 
-    # The team's identifier
+    # ID of this downtime.
     attr_reader :id
 
-    # Team type
+    # Downtime resource type.
     attr_reader :type
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -44,9 +44,9 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'attributes' => :'TeamAttributes',
+        :'attributes' => :'DowntimeUpdateRequestAttributes',
         :'id' => :'String',
-        :'type' => :'TeamType'
+        :'type' => :'DowntimeResourceType'
       }
     end
 
@@ -55,13 +55,13 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::TeamData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::DowntimeUpdateRequestData` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::TeamData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::DowntimeUpdateRequestData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/datadog_api_client/v2/models/event_response_attributes.rb

@@ -24,6 +24,9 @@ module DatadogAPIClient::V2
     # Object description of attributes from your event.
     attr_accessor :attributes
 
+    # The message of the event.
+    attr_accessor :message
+
     # An array of tags associated with the event.
     attr_accessor :tags
 
@@ -35,6 +38,7 @@ module DatadogAPIClient::V2
     def self.attribute_map
       {
         :'attributes' => :'attributes',
+        :'message' => :'message',
         :'tags' => :'tags',
         :'timestamp' => :'timestamp'
       }
@@ -45,6 +49,7 @@ module DatadogAPIClient::V2
     def self.openapi_types
       {
         :'attributes' => :'EventAttributes',
+        :'message' => :'String',
         :'tags' => :'Array<String>',
         :'timestamp' => :'Time'
       }
@@ -70,6 +75,10 @@ module DatadogAPIClient::V2
         self.attributes = attributes[:'attributes']
       end
 
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
       if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
@@ -88,6 +97,7 @@ module DatadogAPIClient::V2
       return true if self.equal?(o)
       self.class == o.class &&
           attributes == o.attributes &&
+          message == o.message &&
           tags == o.tags &&
           timestamp == o.timestamp
     end
@@ -96,7 +106,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [attributes, tags, timestamp].hash
+      [attributes, message, tags, timestamp].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/events_group_by_sort.rb

@@ -24,7 +24,7 @@ module DatadogAPIClient::V2
     # The type of aggregation that can be performed on events-based queries.
     attr_reader :aggregation
 
-    # Metric whose calculated value should be used to define the sort order of a query's results.
+    # The metric's calculated value which should be used to define the sort order of a query's results.
     attr_accessor :metric
 
     # Direction of sort.

data/lib/datadog_api_client/v2/models/events_response_metadata.rb

@@ -30,6 +30,9 @@ module DatadogAPIClient::V2
     # The identifier of the request.
     attr_accessor :request_id
 
+    # The request status.
+    attr_accessor :status
+
     # A list of warnings (non-fatal errors) encountered. Partial results might be returned if
     # warnings are present in the response.
     attr_accessor :warnings
@@ -41,6 +44,7 @@ module DatadogAPIClient::V2
         :'elapsed' => :'elapsed',
         :'page' => :'page',
         :'request_id' => :'request_id',
+        :'status' => :'status',
         :'warnings' => :'warnings'
       }
     end
@@ -52,6 +56,7 @@ module DatadogAPIClient::V2
         :'elapsed' => :'Integer',
         :'page' => :'EventsResponseMetadataPage',
         :'request_id' => :'String',
+        :'status' => :'String',
         :'warnings' => :'Array<EventsWarning>'
       }
     end
@@ -84,6 +89,10 @@ module DatadogAPIClient::V2
         self.request_id = attributes[:'request_id']
       end
 
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
       if attributes.key?(:'warnings')
         if (value = attributes[:'warnings']).is_a?(Array)
           self.warnings = value
@@ -100,6 +109,7 @@ module DatadogAPIClient::V2
           elapsed == o.elapsed &&
           page == o.page &&
           request_id == o.request_id &&
+          status == o.status &&
           warnings == o.warnings
     end
 
@@ -107,7 +117,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [elapsed, page, request_id, warnings].hash
+      [elapsed, page, request_id, status, warnings].hash
     end
   end
 end

data/lib/datadog_api_client/v2/models/formula_limit.rb

@@ -18,6 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Message for specifying limits to the number of values returned by a query.
+  # This limit is only for scalar queries and has no effect on timeseries queries.
   class FormulaLimit
     include BaseGenericModel
 

data/lib/datadog_api_client/v2/models/full_application_key_attributes.rb

@@ -33,7 +33,7 @@ module DatadogAPIClient::V2
     # Name of the application key.
     attr_accessor :name
 
-    # Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
+    # Array of scopes to grant the application key.
     attr_accessor :scopes
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/datadog_api_client/v2/models/list_downtimes_response.rb

@@ -0,0 +1,104 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+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/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Response for retrieving all downtimes.
+  class ListDowntimesResponse
+    include BaseGenericModel
+
+    # An array of downtimes.
+    attr_accessor :data
+
+    # Array of objects related to the downtimes.
+    attr_accessor :included
+
+    # Pagination metadata returned by the API.
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'included' => :'included',
+        :'meta' => :'meta'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'Array<DowntimeResponseData>',
+        :'included' => :'Array<DowntimeResponseIncludedItem>',
+        :'meta' => :'DowntimeMeta'
+      }
+    end
+
+    # Initializes the object
+    # @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::V2::ListDowntimesResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::ListDowntimesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'included')
+        if (value = attributes[:'included']).is_a?(Array)
+          self.included = value
+        end
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          included == o.included &&
+          meta == o.meta
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data, included, meta].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/logs_aggregate_request.rb

@@ -31,7 +31,7 @@ module DatadogAPIClient::V2
     attr_accessor :group_by
 
     # Global query options that are used during the query.
-    # Note: You should only supply timezone or time offset but not both otherwise the query will fail.
+    # Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.
     attr_accessor :options
 
     # Paging settings

data/lib/datadog_api_client/v2/models/logs_aggregate_request_page.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class LogsAggregateRequestPage
     include BaseGenericModel
 
-    # The returned paging point to use to get the next results
+    # The returned paging point to use to get the next results. Note: at most 1000 results can be paged.
     attr_accessor :cursor
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/datadog_api_client/v2/models/logs_group_by.rb

@@ -25,10 +25,11 @@ module DatadogAPIClient::V2
     attr_reader :facet
 
     # Used to perform a histogram computation (only for measure facets).
-    # Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
+    # Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
     attr_accessor :histogram
 
-    # The maximum buckets to return for this group by
+    # The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed.
+    # If grouping by multiple facets, the product of limits must not exceed 10000.
     attr_accessor :limit
 
     # The value to use for logs that don't have the facet used to group by

data/lib/datadog_api_client/v2/models/logs_group_by_histogram.rb

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Used to perform a histogram computation (only for measure facets).
-  # Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
+  # Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
   class LogsGroupByHistogram
     include BaseGenericModel
 

data/lib/datadog_api_client/v2/models/logs_list_request.rb

@@ -25,7 +25,7 @@ module DatadogAPIClient::V2
     attr_accessor :filter
 
     # Global query options that are used during the query.
-    # Note: You should only supply timezone or time offset but not both otherwise the query will fail.
+    # Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.
     attr_accessor :options
 
     # Paging attributes for listing logs.

data/lib/datadog_api_client/v2/models/logs_query_options.rb

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Global query options that are used during the query.
-  # Note: You should only supply timezone or time offset but not both otherwise the query will fail.
+  # Note: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.
   class LogsQueryOptions
     include BaseGenericModel
 

data/lib/datadog_api_client/v2/models/logs_response_metadata_page.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class LogsResponseMetadataPage
     include BaseGenericModel
 
-    # The cursor to use to get the next results, if any. To make the next request, use the same.
+    # The cursor to use to get the next results, if any. To make the next request, use the same
     # parameters with the addition of the `page[cursor]`.
     attr_accessor :after
 

data/lib/datadog_api_client/v2/models/metrics_aggregator.rb

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The type of aggregation that can be performed on metrics queries.
+  # The type of aggregation that can be performed on metrics-based queries.
   class MetricsAggregator
     include BaseEnumModel
 

data/lib/datadog_api_client/v2/models/metrics_scalar_query.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class MetricsScalarQuery
     include BaseGenericModel
 
-    # The type of aggregation that can be performed on metrics queries.
+    # The type of aggregation that can be performed on metrics-based queries.
     attr_reader :aggregator
 
     # A data source that is powered by the Metrics platform.

data/lib/datadog_api_client/v2/models/monitor_downtime_match_resource_type.rb

@@ -0,0 +1,26 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+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/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Monitor Downtime Match resource type.
+  class MonitorDowntimeMatchResourceType
+    include BaseEnumModel
+
+    DOWNTIME_MATCH = "downtime_match".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/monitor_downtime_match_response.rb

@@ -0,0 +1,92 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+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/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Response for retrieving all downtime matches for a monitor.
+  class MonitorDowntimeMatchResponse
+    include BaseGenericModel
+
+    # An array of downtime matches.
+    attr_accessor :data
+
+    # Pagination metadata returned by the API.
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'Array<MonitorDowntimeMatchResponseData>',
+        :'meta' => :'DowntimeMeta'
+      }
+    end
+
+    # Initializes the object
+    # @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::V2::MonitorDowntimeMatchResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::MonitorDowntimeMatchResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          meta == o.meta
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data, meta].hash
+    end
+  end
+end