datadog_api_client 2.39.0 → 2.41.0

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

@@ -0,0 +1,240 @@
+=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 `socket` destination sends logs over TCP or UDP to a remote server.
+  class ObservabilityPipelineSocketDestination
+    include BaseGenericModel
+
+    # Encoding format for log events.
+    attr_reader :encoding
+
+    # Framing method configuration.
+    attr_reader :framing
+
+    # The unique identifier for this component.
+    attr_reader :id
+
+    # A list of component IDs whose output is used as the `input` for this component.
+    attr_reader :inputs
+
+    # Protocol used to send logs.
+    attr_reader :mode
+
+    # Configuration for enabling TLS encryption between the pipeline component and external services.
+    attr_accessor :tls
+
+    # The destination type. The value should always be `socket`.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'encoding' => :'encoding',
+        :'framing' => :'framing',
+        :'id' => :'id',
+        :'inputs' => :'inputs',
+        :'mode' => :'mode',
+        :'tls' => :'tls',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'encoding' => :'ObservabilityPipelineSocketDestinationEncoding',
+        :'framing' => :'ObservabilityPipelineSocketDestinationFraming',
+        :'id' => :'String',
+        :'inputs' => :'Array<String>',
+        :'mode' => :'ObservabilityPipelineSocketDestinationMode',
+        :'tls' => :'ObservabilityPipelineTls',
+        :'type' => :'ObservabilityPipelineSocketDestinationType'
+      }
+    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::ObservabilityPipelineSocketDestination` 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?(:'encoding')
+        self.encoding = attributes[:'encoding']
+      end
+
+      if attributes.key?(:'framing')
+        self.framing = attributes[:'framing']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'inputs')
+        if (value = attributes[:'inputs']).is_a?(Array)
+          self.inputs = value
+        end
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.key?(:'tls')
+        self.tls = attributes[:'tls']
+      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 @encoding.nil?
+      return false if @framing.nil?
+      return false if @id.nil?
+      return false if @inputs.nil?
+      return false if @mode.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param encoding [Object] Object to be assigned
+    # @!visibility private
+    def encoding=(encoding)
+      if encoding.nil?
+        fail ArgumentError, 'invalid value for "encoding", encoding cannot be nil.'
+      end
+      @encoding = encoding
+    end
+
+    # Custom attribute writer method with validation
+    # @param framing [Object] Object to be assigned
+    # @!visibility private
+    def framing=(framing)
+      if framing.nil?
+        fail ArgumentError, 'invalid value for "framing", framing cannot be nil.'
+      end
+      @framing = framing
+    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 inputs [Object] Object to be assigned
+    # @!visibility private
+    def inputs=(inputs)
+      if inputs.nil?
+        fail ArgumentError, 'invalid value for "inputs", inputs cannot be nil.'
+      end
+      @inputs = inputs
+    end
+
+    # Custom attribute writer method with validation
+    # @param mode [Object] Object to be assigned
+    # @!visibility private
+    def mode=(mode)
+      if mode.nil?
+        fail ArgumentError, 'invalid value for "mode", mode cannot be nil.'
+      end
+      @mode = mode
+    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 &&
+          encoding == o.encoding &&
+          framing == o.framing &&
+          id == o.id &&
+          inputs == o.inputs &&
+          mode == o.mode &&
+          tls == o.tls &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [encoding, framing, id, inputs, mode, tls, type, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+=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
+  # Encoding format for log events.
+  class ObservabilityPipelineSocketDestinationEncoding
+    include BaseEnumModel
+
+    JSON = "json".freeze
+    RAW_MESSAGE = "raw_message".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing.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
+  # Framing method configuration.
+  module ObservabilityPipelineSocketDestinationFraming
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ObservabilityPipelineSocketDestinationFramingNewlineDelimited',
+          :'ObservabilityPipelineSocketDestinationFramingBytes',
+          :'ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
+        ]
+      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/observability_pipeline_socket_destination_framing_bytes.rb

@@ -0,0 +1,123 @@
+=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
+  # Event data is not delimited at all.
+  class ObservabilityPipelineSocketDestinationFramingBytes
+    include BaseGenericModel
+
+    # The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod` object.
+    attr_reader :method
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'method' => :'method'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'method' => :'ObservabilityPipelineSocketDestinationFramingBytesMethod'
+      }
+    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::ObservabilityPipelineSocketDestinationFramingBytes` 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?(:'method')
+        self.method = attributes[:'method']
+      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 @method.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param method [Object] Object to be assigned
+    # @!visibility private
+    def method=(method)
+      if method.nil?
+        fail ArgumentError, 'invalid value for "method", method cannot be nil.'
+      end
+      @method = method
+    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 &&
+          method == o.method &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [method, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_bytes_method.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
+  # The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod` object.
+  class ObservabilityPipelineSocketDestinationFramingBytesMethod
+    include BaseEnumModel
+
+    BYTES = "bytes".freeze
+  end
+end

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

@@ -0,0 +1,152 @@
+=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
+  # Each log event is separated using the specified delimiter character.
+  class ObservabilityPipelineSocketDestinationFramingCharacterDelimited
+    include BaseGenericModel
+
+    # A single ASCII character used as a delimiter.
+    attr_reader :delimiter
+
+    # The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod` object.
+    attr_reader :method
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'delimiter' => :'delimiter',
+        :'method' => :'method'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'delimiter' => :'String',
+        :'method' => :'ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
+      }
+    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::ObservabilityPipelineSocketDestinationFramingCharacterDelimited` 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?(:'delimiter')
+        self.delimiter = attributes[:'delimiter']
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      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 @delimiter.nil?
+      return false if @delimiter.to_s.length > 1
+      return false if @delimiter.to_s.length < 1
+      return false if @method.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param delimiter [Object] Object to be assigned
+    # @!visibility private
+    def delimiter=(delimiter)
+      if delimiter.nil?
+        fail ArgumentError, 'invalid value for "delimiter", delimiter cannot be nil.'
+      end
+      if delimiter.to_s.length > 1
+        fail ArgumentError, 'invalid value for "delimiter", the character length must be smaller than or equal to 1.'
+      end
+      if delimiter.to_s.length < 1
+        fail ArgumentError, 'invalid value for "delimiter", the character length must be great than or equal to 1.'
+      end
+      @delimiter = delimiter
+    end
+
+    # Custom attribute writer method with validation
+    # @param method [Object] Object to be assigned
+    # @!visibility private
+    def method=(method)
+      if method.nil?
+        fail ArgumentError, 'invalid value for "method", method cannot be nil.'
+      end
+      @method = method
+    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 &&
+          delimiter == o.delimiter &&
+          method == o.method &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [delimiter, method, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_socket_destination_framing_character_delimited_method.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
+  # The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod` object.
+  class ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod
+    include BaseEnumModel
+
+    CHARACTER_DELIMITED = "character_delimited".freeze
+  end
+end