datadog_api_client 2.43.0 → 2.45.0

data/lib/datadog_api_client/v1/api/aws_integration_api.rb

@@ -33,7 +33,7 @@ module DatadogAPIClient::V1
 
     # Create an AWS integration.
     #
-    # Create a Datadog-Amazon Web Services integration.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration.
     # Using the `POST` method updates your integration configuration
     # by adding your new configuration to the existing one in your Datadog organization.
     # A unique AWS Account ID for role based authentication.
@@ -106,12 +106,15 @@ module DatadogAPIClient::V1
 
     # Create an Amazon EventBridge source.
     #
-    # Create an Amazon EventBridge source.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Create an Amazon EventBridge source.
+    #
+    # @deprecated This API is deprecated.
     #
     # @param body [AWSEventBridgeCreateRequest] Create an Amazon EventBridge source for an AWS account with a given name and region.
     # @param opts [Hash] the optional parameters
     # @return [Array<(AWSEventBridgeCreateResponse, Integer, Hash)>] AWSEventBridgeCreateResponse data, response status code and response headers
     def create_aws_event_bridge_source_with_http_info(body, opts = {})
+      warn "[DEPRECATION] `CreateAWSEventBridgeSource` is deprecated."
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.create_aws_event_bridge_source ...'
@@ -243,7 +246,7 @@ module DatadogAPIClient::V1
 
     # Generate a new external ID.
     #
-    # Generate a new AWS external ID for a given AWS account ID and role name pair.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair.
     #
     # @deprecated This API is deprecated.
     #
@@ -313,7 +316,7 @@ module DatadogAPIClient::V1
 
     # Delete an AWS integration.
     #
-    # Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
     #
     # @deprecated This API is deprecated.
     #
@@ -383,12 +386,15 @@ module DatadogAPIClient::V1
 
     # Delete an Amazon EventBridge source.
     #
-    # Delete an Amazon EventBridge source.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Delete an Amazon EventBridge source.
+    #
+    # @deprecated This API is deprecated.
     #
     # @param body [AWSEventBridgeDeleteRequest] Delete the Amazon EventBridge source with the given name, region, and associated AWS account.
     # @param opts [Hash] the optional parameters
     # @return [Array<(AWSEventBridgeDeleteResponse, Integer, Hash)>] AWSEventBridgeDeleteResponse data, response status code and response headers
     def delete_aws_event_bridge_source_with_http_info(body, opts = {})
+      warn "[DEPRECATION] `DeleteAWSEventBridgeSource` is deprecated."
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.delete_aws_event_bridge_source ...'
@@ -520,7 +526,7 @@ module DatadogAPIClient::V1
 
     # List namespace rules.
     #
-    # List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
     #
     # @deprecated This API is deprecated.
     #
@@ -583,7 +589,7 @@ module DatadogAPIClient::V1
 
     # List all AWS integrations.
     #
-    # List all Datadog-AWS integrations available in your Datadog organization.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization.
     #
     # @deprecated This API is deprecated.
     #
@@ -652,11 +658,14 @@ module DatadogAPIClient::V1
 
     # Get all Amazon EventBridge sources.
     #
-    # Get all Amazon EventBridge sources.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Get all Amazon EventBridge sources.
+    #
+    # @deprecated This API is deprecated.
     #
     # @param opts [Hash] the optional parameters
     # @return [Array<(AWSEventBridgeListResponse, Integer, Hash)>] AWSEventBridgeListResponse data, response status code and response headers
     def list_aws_event_bridge_sources_with_http_info(opts = {})
+      warn "[DEPRECATION] `ListAWSEventBridgeSources` is deprecated."
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.list_aws_event_bridge_sources ...'
@@ -781,7 +790,7 @@ module DatadogAPIClient::V1
 
     # Update an AWS integration.
     #
-    # Update a Datadog-Amazon Web Services integration.
+    # **This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration.
     #
     # @deprecated This API is deprecated.
     #

data/lib/datadog_api_client/v1/api/aws_logs_integration_api.rb

@@ -450,7 +450,7 @@ module DatadogAPIClient::V1
 
     # Get list of AWS log ready services.
     #
-    # Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
+    # **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
     #
     # @deprecated This API is deprecated.
     #

data/lib/datadog_api_client/v1/api/hosts_api.rb

@@ -101,6 +101,7 @@ module DatadogAPIClient::V1
     # Retention is 7 days.
     # Results are paginated with a max of 1000 results at a time.
     # **Note:** If the host is an Amazon EC2 instance, `id` is replaced with `aws_id` in the response.
+    # **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint.
     #
     # @param opts [Hash] the optional parameters
     # @option opts [String] :filter String to filter search results.

data/lib/datadog_api_client/v1/api/key_management_api.rb

@@ -101,6 +101,7 @@ module DatadogAPIClient::V1
     # Create an application key.
     #
     # Create an application key with a given name.
+    # This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
     #
     # @param body [ApplicationKey] 
     # @param opts [Hash] the optional parameters
@@ -233,6 +234,7 @@ module DatadogAPIClient::V1
     # Delete an application key.
     #
     # Delete a given application key.
+    # This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
     #
     # @param key [String] The specific APP key you are working with.
     # @param opts [Hash] the optional parameters
@@ -363,6 +365,7 @@ module DatadogAPIClient::V1
     # Get an application key.
     #
     # Get a given application key.
+    # This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
     #
     # @param key [String] The specific APP key you are working with.
     # @param opts [Hash] the optional parameters
@@ -488,6 +491,7 @@ module DatadogAPIClient::V1
     # Get all application keys.
     #
     # Get all application keys available for your Datadog account.
+    # This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
     #
     # @param opts [Hash] the optional parameters
     # @return [Array<(ApplicationKeyListResponse, Integer, Hash)>] ApplicationKeyListResponse data, response status code and response headers
@@ -620,6 +624,7 @@ module DatadogAPIClient::V1
     # Edit an application key.
     #
     # Edit an application key name.
+    # This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
     #
     # @param key [String] The specific APP key you are working with.
     # @param body [ApplicationKey] 

data/lib/datadog_api_client/v1/api/metrics_api.rb

@@ -168,12 +168,17 @@ module DatadogAPIClient::V1
 
     # Search metrics.
     #
+    # **Note**: This endpoint is deprecated. Use `/api/v2/metrics` instead.
+    #
     # Search for metrics from the last 24 hours in Datadog.
     #
+    # @deprecated This API is deprecated.
+    #
     # @param q [String] Query string to search metrics upon. Can optionally be prefixed with `metrics:`.
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricSearchResponse, Integer, Hash)>] MetricSearchResponse data, response status code and response headers
     def list_metrics_with_http_info(q, opts = {})
+      warn "[DEPRECATION] `ListMetrics` is deprecated."
 
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.list_metrics ...'

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

@@ -27,9 +27,11 @@ module DatadogAPIClient::V1
     # Your AWS Account ID without dashes.
     attr_accessor :account_id
 
-    # An object, (in the form `{"namespace1":true/false, "namespace2":true/false}`),
-    # that enables or disables metric collection for specific AWS namespaces for this
-    # AWS account only.
+    # An object (in the form `{"namespace1":true/false, "namespace2":true/false}`) containing user-supplied overrides
+    # for AWS namespace metric collection. **Important**: This field only contains namespaces explicitly configured through API calls,
+    # not the comprehensive enabled or disabled status of all namespaces. If a namespace is absent from this field, it uses Datadog's
+    # internal defaults (all namespaces enabled by default, except `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage`).
+    # For a complete view of all namespace statuses, use the V2 AWS Integration API instead.
     attr_accessor :account_specific_namespace_rules
 
     # Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`.

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

@@ -33,5 +33,6 @@ module DatadogAPIClient::V1
     CI_PIPELINES = "ci_pipelines".freeze
     INCIDENT_ANALYTICS = "incident_analytics".freeze
     PRODUCT_ANALYTICS = "product_analytics".freeze
+    ON_CALL_EVENTS = "on_call_events".freeze
   end
 end

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

@@ -44,7 +44,8 @@ module DatadogAPIClient::V1
           :'LogsTraceRemapper',
           :'LogsSpanRemapper',
           :'LogsArrayProcessor',
-          :'LogsDecoderProcessor'
+          :'LogsDecoderProcessor',
+          :'LogsSchemaProcessor'
         ]
       end
       # Builds the object

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

@@ -0,0 +1,211 @@
+=begin
+#Datadog API V1 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::V1
+  # Use the Schema Category Mapper to categorize log event into enum fields.
+  # In the case of OCSF, they can be used to map sibling fields which are composed of an ID and a name.
+  # 
+  # **Notes**:
+  # 
+  # - The syntax of the query is the one of Logs Explorer search bar.
+  #   The query can be done on any log attribute or tag, whether it is a facet or not.
+  #   Wildcards can also be used inside your query.
+  # - Categories are executed in order and processing stops at the first match.
+  #   Make sure categories are properly ordered in case a log could match multiple queries.
+  # - Sibling fields always have a numerical ID field and a human-readable string name.
+  # - A fallback section handles cases where the name or ID value matches a specific value.
+  #   If the name matches "Other" or the ID matches 99, the value of the sibling name field will be pulled from a source field from the original log.
+  class LogsSchemaCategoryMapper
+    include BaseGenericModel
+
+    # Array of filters to match or not a log and their
+    # corresponding `name` to assign a custom value to the log.
+    attr_reader :categories
+
+    # Used to override hardcoded category values with a value pulled from a source attribute on the log.
+    attr_accessor :fallback
+
+    # Name of the logs schema category mapper.
+    attr_reader :name
+
+    # Name of the target attributes which value is defined by the matching category.
+    attr_reader :targets
+
+    # Type of logs schema category mapper.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'categories' => :'categories',
+        :'fallback' => :'fallback',
+        :'name' => :'name',
+        :'targets' => :'targets',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'categories' => :'Array<LogsSchemaCategoryMapperCategory>',
+        :'fallback' => :'LogsSchemaCategoryMapperFallback',
+        :'name' => :'String',
+        :'targets' => :'LogsSchemaCategoryMapperTargets',
+        :'type' => :'LogsSchemaCategoryMapperType'
+      }
+    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::V1::LogsSchemaCategoryMapper` initialize method"
+      end
+
+      self.additional_properties = {}
+      # 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))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'categories')
+        if (value = attributes[:'categories']).is_a?(Array)
+          self.categories = value
+        end
+      end
+
+      if attributes.key?(:'fallback')
+        self.fallback = attributes[:'fallback']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'targets')
+        self.targets = attributes[:'targets']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @categories.nil?
+      return false if @name.nil?
+      return false if @targets.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param categories [Object] Object to be assigned
+    # @!visibility private
+    def categories=(categories)
+      if categories.nil?
+        fail ArgumentError, 'invalid value for "categories", categories cannot be nil.'
+      end
+      @categories = categories
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param targets [Object] Object to be assigned
+    # @!visibility private
+    def targets=(targets)
+      if targets.nil?
+        fail ArgumentError, 'invalid value for "targets", targets cannot be nil.'
+      end
+      @targets = targets
+    end
+
+    # Custom attribute writer method with validation
+    # @param type [Object] Object to be assigned
+    # @!visibility private
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'invalid value for "type", type cannot be nil.'
+      end
+      @type = type
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @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
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    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 &&
+          categories == o.categories &&
+          fallback == o.fallback &&
+          name == o.name &&
+          targets == o.targets &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [categories, fallback, name, targets, type, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+=begin
+#Datadog API V1 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::V1
+  # Object describing the logs filter with corresponding category ID and name assignment.
+  class LogsSchemaCategoryMapperCategory
+    include BaseGenericModel
+
+    # Filter for logs.
+    attr_reader :filter
+
+    # ID to inject into the category.
+    attr_reader :id
+
+    # Value to assign to target schema field.
+    attr_reader :name
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'filter' => :'filter',
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'filter' => :'LogsFilter',
+        :'id' => :'Integer',
+        :'name' => :'String'
+      }
+    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::V1::LogsSchemaCategoryMapperCategory` initialize method"
+      end
+
+      self.additional_properties = {}
+      # 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))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'filter')
+        self.filter = attributes[:'filter']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @filter.nil?
+      return false if @id.nil?
+      return false if @name.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param filter [Object] Object to be assigned
+    # @!visibility private
+    def filter=(filter)
+      if filter.nil?
+        fail ArgumentError, 'invalid value for "filter", filter cannot be nil.'
+      end
+      @filter = filter
+    end
+
+    # Custom attribute writer method with validation
+    # @param id [Object] Object to be assigned
+    # @!visibility private
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'invalid value for "id", id cannot be nil.'
+      end
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @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
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    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 &&
+          filter == o.filter &&
+          id == o.id &&
+          name == o.name &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [filter, id, name, additional_properties].hash
+    end
+  end
+end