datadog_api_client 2.20.0 → 2.21.0

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

@@ -0,0 +1,64 @@
+=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
+  # A custom destination's location to forward logs.
+  module CustomDestinationForwardDestination
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'CustomDestinationForwardDestinationHttp',
+          :'CustomDestinationForwardDestinationSplunk',
+          :'CustomDestinationForwardDestinationElasticsearch'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,181 @@
+=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
+  # The Elasticsearch destination.
+  class CustomDestinationForwardDestinationElasticsearch
+    include BaseGenericModel
+
+    # Basic access authentication.
+    attr_reader :auth
+
+    # The destination for which logs will be forwarded to.
+    # Must have HTTPS scheme and forwarding back to Datadog is not allowed.
+    attr_reader :endpoint
+
+    # Name of the Elasticsearch index (must follow [Elasticsearch's criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
+    attr_reader :index_name
+
+    # Date pattern with US locale and UTC timezone to be appended to the index name after adding `-`
+    # (that is, `${index_name}-${indexPattern}`).
+    # You can customize the index rotation naming pattern by choosing one of these options:
+    # - Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`)
+    # - Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`)
+    # - Weekly: `yyyy-'W'ww` (as an example, it would render: `2022-W42`)
+    # - Monthly: `yyyy-MM` (as an example, it would render: `2022-10`)
+    #
+    # If this field is missing or is blank, it means that the index name will always be the same
+    # (that is, no rotation).
+    attr_accessor :index_rotation
+
+    # Type of the Elasticsearch destination.
+    attr_reader :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'auth' => :'auth',
+        :'endpoint' => :'endpoint',
+        :'index_name' => :'index_name',
+        :'index_rotation' => :'index_rotation',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'auth' => :'CustomDestinationElasticsearchDestinationAuth',
+        :'endpoint' => :'String',
+        :'index_name' => :'String',
+        :'index_rotation' => :'String',
+        :'type' => :'CustomDestinationForwardDestinationElasticsearchType'
+      }
+    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::CustomDestinationForwardDestinationElasticsearch` 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::CustomDestinationForwardDestinationElasticsearch`. 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?(:'auth')
+        self.auth = attributes[:'auth']
+      end
+
+      if attributes.key?(:'endpoint')
+        self.endpoint = attributes[:'endpoint']
+      end
+
+      if attributes.key?(:'index_name')
+        self.index_name = attributes[:'index_name']
+      end
+
+      if attributes.key?(:'index_rotation')
+        self.index_rotation = attributes[:'index_rotation']
+      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 @auth.nil?
+      return false if @endpoint.nil?
+      return false if @index_name.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param auth [Object] Object to be assigned
+    # @!visibility private
+    def auth=(auth)
+      if auth.nil?
+        fail ArgumentError, 'invalid value for "auth", auth cannot be nil.'
+      end
+      @auth = auth
+    end
+
+    # Custom attribute writer method with validation
+    # @param endpoint [Object] Object to be assigned
+    # @!visibility private
+    def endpoint=(endpoint)
+      if endpoint.nil?
+        fail ArgumentError, 'invalid value for "endpoint", endpoint cannot be nil.'
+      end
+      @endpoint = endpoint
+    end
+
+    # Custom attribute writer method with validation
+    # @param index_name [Object] Object to be assigned
+    # @!visibility private
+    def index_name=(index_name)
+      if index_name.nil?
+        fail ArgumentError, 'invalid value for "index_name", index_name cannot be nil.'
+      end
+      @index_name = index_name
+    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
+
+    # 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 &&
+          auth == o.auth &&
+          endpoint == o.endpoint &&
+          index_name == o.index_name &&
+          index_rotation == o.index_rotation &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [auth, endpoint, index_name, index_rotation, type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_elasticsearch_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
+  # Type of the Elasticsearch destination.
+  class CustomDestinationForwardDestinationElasticsearchType
+    include BaseEnumModel
+
+    ELASTICSEARCH = "elasticsearch".freeze
+  end
+end

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

@@ -0,0 +1,141 @@
+=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
+  # The HTTP destination.
+  class CustomDestinationForwardDestinationHttp
+    include BaseGenericModel
+
+    # Authentication method of the HTTP requests.
+    attr_reader :auth
+
+    # The destination for which logs will be forwarded to.
+    # Must have HTTPS scheme and forwarding back to Datadog is not allowed.
+    attr_reader :endpoint
+
+    # Type of the HTTP destination.
+    attr_reader :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'auth' => :'auth',
+        :'endpoint' => :'endpoint',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'auth' => :'CustomDestinationHttpDestinationAuth',
+        :'endpoint' => :'String',
+        :'type' => :'CustomDestinationForwardDestinationHttpType'
+      }
+    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::CustomDestinationForwardDestinationHttp` 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::CustomDestinationForwardDestinationHttp`. 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?(:'auth')
+        self.auth = attributes[:'auth']
+      end
+
+      if attributes.key?(:'endpoint')
+        self.endpoint = attributes[:'endpoint']
+      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 @auth.nil?
+      return false if @endpoint.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param auth [Object] Object to be assigned
+    # @!visibility private
+    def auth=(auth)
+      if auth.nil?
+        fail ArgumentError, 'invalid value for "auth", auth cannot be nil.'
+      end
+      @auth = auth
+    end
+
+    # Custom attribute writer method with validation
+    # @param endpoint [Object] Object to be assigned
+    # @!visibility private
+    def endpoint=(endpoint)
+      if endpoint.nil?
+        fail ArgumentError, 'invalid value for "endpoint", endpoint cannot be nil.'
+      end
+      @endpoint = endpoint
+    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
+
+    # 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 &&
+          auth == o.auth &&
+          endpoint == o.endpoint &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [auth, endpoint, type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_http_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
+  # Type of the HTTP destination.
+  class CustomDestinationForwardDestinationHttpType
+    include BaseEnumModel
+
+    HTTP = "http".freeze
+  end
+end

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

@@ -0,0 +1,141 @@
+=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
+  # The Splunk HTTP Event Collector (HEC) destination.
+  class CustomDestinationForwardDestinationSplunk
+    include BaseGenericModel
+
+    # Access token of the Splunk HTTP Event Collector. This field is not returned by the API.
+    attr_reader :access_token
+
+    # The destination for which logs will be forwarded to.
+    # Must have HTTPS scheme and forwarding back to Datadog is not allowed.
+    attr_reader :endpoint
+
+    # Type of the Splunk HTTP Event Collector (HEC) destination.
+    attr_reader :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'access_token' => :'access_token',
+        :'endpoint' => :'endpoint',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'access_token' => :'String',
+        :'endpoint' => :'String',
+        :'type' => :'CustomDestinationForwardDestinationSplunkType'
+      }
+    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::CustomDestinationForwardDestinationSplunk` 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::CustomDestinationForwardDestinationSplunk`. 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?(:'access_token')
+        self.access_token = attributes[:'access_token']
+      end
+
+      if attributes.key?(:'endpoint')
+        self.endpoint = attributes[:'endpoint']
+      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 @access_token.nil?
+      return false if @endpoint.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param access_token [Object] Object to be assigned
+    # @!visibility private
+    def access_token=(access_token)
+      if access_token.nil?
+        fail ArgumentError, 'invalid value for "access_token", access_token cannot be nil.'
+      end
+      @access_token = access_token
+    end
+
+    # Custom attribute writer method with validation
+    # @param endpoint [Object] Object to be assigned
+    # @!visibility private
+    def endpoint=(endpoint)
+      if endpoint.nil?
+        fail ArgumentError, 'invalid value for "endpoint", endpoint cannot be nil.'
+      end
+      @endpoint = endpoint
+    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
+
+    # 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 &&
+          access_token == o.access_token &&
+          endpoint == o.endpoint &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [access_token, endpoint, type].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/custom_destination_forward_destination_splunk_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
+  # Type of the Splunk HTTP Event Collector (HEC) destination.
+  class CustomDestinationForwardDestinationSplunkType
+    include BaseEnumModel
+
+    SPLUNK_HEC = "splunk_hec".freeze
+  end
+end

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

@@ -0,0 +1,63 @@
+=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
+  # Authentication method of the HTTP requests.
+  module CustomDestinationHttpDestinationAuth
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'CustomDestinationHttpDestinationAuthBasic',
+          :'CustomDestinationHttpDestinationAuthCustomHeader'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end