datadog_api_client 2.55.0 → 2.56.0

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

@@ -0,0 +1,248 @@
+=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 `websocket` source ingests logs from a WebSocket server using the `ws://` or `wss://` protocol.
+  # 
+  # **Supported pipeline types:** logs.
+  class ObservabilityPipelineWebsocketSource
+    include BaseGenericModel
+
+    # Authentication strategy for the WebSocket source connection.
+    attr_reader :auth_strategy
+
+    # Name of the environment variable or secret that holds the custom authorization header value. Used when `auth_strategy` is `custom`.
+    attr_accessor :custom_key
+
+    # The decoding format used to interpret incoming logs.
+    attr_reader :decoding
+
+    # The unique identifier for this component.
+    attr_reader :id
+
+    # Name of the environment variable or secret that holds the password. Used when `auth_strategy` is `basic`.
+    attr_accessor :password_key
+
+    # TLS configuration for the WebSocket source. Use `enabled` for standard `wss://` connections, or `with_client_cert` to present a client certificate for mutual TLS.
+    attr_accessor :tls
+
+    # Name of the environment variable or secret that holds the bearer token. Used when `auth_strategy` is `bearer`.
+    attr_accessor :token_key
+
+    # The source type. The value should always be `websocket`.
+    attr_reader :type
+
+    # Name of the environment variable or secret that holds the WebSocket server URI (`ws://` or `wss://`).
+    attr_accessor :uri_key
+
+    # Name of the environment variable or secret that holds the username. Used when `auth_strategy` is `basic`.
+    attr_accessor :username_key
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'auth_strategy' => :'auth_strategy',
+        :'custom_key' => :'custom_key',
+        :'decoding' => :'decoding',
+        :'id' => :'id',
+        :'password_key' => :'password_key',
+        :'tls' => :'tls',
+        :'token_key' => :'token_key',
+        :'type' => :'type',
+        :'uri_key' => :'uri_key',
+        :'username_key' => :'username_key'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'auth_strategy' => :'ObservabilityPipelineWebsocketSourceAuthStrategy',
+        :'custom_key' => :'String',
+        :'decoding' => :'ObservabilityPipelineDecoding',
+        :'id' => :'String',
+        :'password_key' => :'String',
+        :'tls' => :'ObservabilityPipelineWebsocketSourceTls',
+        :'token_key' => :'String',
+        :'type' => :'ObservabilityPipelineWebsocketSourceType',
+        :'uri_key' => :'String',
+        :'username_key' => :'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::V2::ObservabilityPipelineWebsocketSource` 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?(:'auth_strategy')
+        self.auth_strategy = attributes[:'auth_strategy']
+      end
+
+      if attributes.key?(:'custom_key')
+        self.custom_key = attributes[:'custom_key']
+      end
+
+      if attributes.key?(:'decoding')
+        self.decoding = attributes[:'decoding']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'password_key')
+        self.password_key = attributes[:'password_key']
+      end
+
+      if attributes.key?(:'tls')
+        self.tls = attributes[:'tls']
+      end
+
+      if attributes.key?(:'token_key')
+        self.token_key = attributes[:'token_key']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'uri_key')
+        self.uri_key = attributes[:'uri_key']
+      end
+
+      if attributes.key?(:'username_key')
+        self.username_key = attributes[:'username_key']
+      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_strategy.nil?
+      return false if @decoding.nil?
+      return false if @id.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param auth_strategy [Object] Object to be assigned
+    # @!visibility private
+    def auth_strategy=(auth_strategy)
+      if auth_strategy.nil?
+        fail ArgumentError, 'invalid value for "auth_strategy", auth_strategy cannot be nil.'
+      end
+      @auth_strategy = auth_strategy
+    end
+
+    # Custom attribute writer method with validation
+    # @param decoding [Object] Object to be assigned
+    # @!visibility private
+    def decoding=(decoding)
+      if decoding.nil?
+        fail ArgumentError, 'invalid value for "decoding", decoding cannot be nil.'
+      end
+      @decoding = decoding
+    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 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 &&
+          auth_strategy == o.auth_strategy &&
+          custom_key == o.custom_key &&
+          decoding == o.decoding &&
+          id == o.id &&
+          password_key == o.password_key &&
+          tls == o.tls &&
+          token_key == o.token_key &&
+          type == o.type &&
+          uri_key == o.uri_key &&
+          username_key == o.username_key &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [auth_strategy, custom_key, decoding, id, password_key, tls, token_key, type, uri_key, username_key, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+=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 strategy for the WebSocket source connection.
+  class ObservabilityPipelineWebsocketSourceAuthStrategy
+    include BaseEnumModel
+
+    NONE = "none".freeze
+    BASIC = "basic".freeze
+    BEARER = "bearer".freeze
+    CUSTOM = "custom".freeze
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_websocket_source_tls.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
+  # TLS configuration for the WebSocket source. Use `enabled` for standard `wss://` connections, or `with_client_cert` to present a client certificate for mutual TLS.
+  module ObservabilityPipelineWebsocketSourceTls
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ObservabilityPipelineWebsocketSourceTlsEnabled',
+          :'ObservabilityPipelineWebsocketSourceTlsWithClientCert'
+        ]
+      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_websocket_source_tls_enabled.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
+  # TLS configuration that enables encryption without a client certificate. Use this for standard `wss://` connections that do not require mutual TLS.
+  class ObservabilityPipelineWebsocketSourceTlsEnabled
+    include BaseGenericModel
+
+    # TLS mode. Must be `enabled`.
+    attr_reader :mode
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'mode' => :'mode'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'mode' => :'ObservabilityPipelineWebsocketSourceTlsEnabledMode'
+      }
+    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::ObservabilityPipelineWebsocketSourceTlsEnabled` 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?(:'mode')
+        self.mode = attributes[:'mode']
+      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 @mode.nil?
+      true
+    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
+
+    # 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 &&
+          mode == o.mode &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [mode, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_websocket_source_tls_enabled_mode.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
+  # TLS mode. Must be `enabled`.
+  class ObservabilityPipelineWebsocketSourceTlsEnabledMode
+    include BaseEnumModel
+
+    ENABLED = "enabled".freeze
+  end
+end

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

@@ -0,0 +1,174 @@
+=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
+  # TLS configuration that enables encryption and presents a client certificate for mutual TLS authentication.
+  class ObservabilityPipelineWebsocketSourceTlsWithClientCert
+    include BaseGenericModel
+
+    # Path to the Certificate Authority (CA) file used to validate the remote server's TLS certificate.
+    attr_accessor :ca_file
+
+    # Path to the TLS client certificate file used to identify this source to the remote server.
+    attr_reader :crt_file
+
+    # Path to the private key file associated with the client certificate.
+    attr_accessor :key_file
+
+    # Name of the environment variable or secret that holds the passphrase for the private key file.
+    attr_accessor :key_pass_key
+
+    # TLS mode. Must be `with_client_cert`.
+    attr_reader :mode
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'ca_file' => :'ca_file',
+        :'crt_file' => :'crt_file',
+        :'key_file' => :'key_file',
+        :'key_pass_key' => :'key_pass_key',
+        :'mode' => :'mode'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'ca_file' => :'String',
+        :'crt_file' => :'String',
+        :'key_file' => :'String',
+        :'key_pass_key' => :'String',
+        :'mode' => :'ObservabilityPipelineWebsocketSourceTlsWithClientCertMode'
+      }
+    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::ObservabilityPipelineWebsocketSourceTlsWithClientCert` 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?(:'ca_file')
+        self.ca_file = attributes[:'ca_file']
+      end
+
+      if attributes.key?(:'crt_file')
+        self.crt_file = attributes[:'crt_file']
+      end
+
+      if attributes.key?(:'key_file')
+        self.key_file = attributes[:'key_file']
+      end
+
+      if attributes.key?(:'key_pass_key')
+        self.key_pass_key = attributes[:'key_pass_key']
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      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 @crt_file.nil?
+      return false if @mode.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param crt_file [Object] Object to be assigned
+    # @!visibility private
+    def crt_file=(crt_file)
+      if crt_file.nil?
+        fail ArgumentError, 'invalid value for "crt_file", crt_file cannot be nil.'
+      end
+      @crt_file = crt_file
+    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
+
+    # 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 &&
+          ca_file == o.ca_file &&
+          crt_file == o.crt_file &&
+          key_file == o.key_file &&
+          key_pass_key == o.key_pass_key &&
+          mode == o.mode &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [ca_file, crt_file, key_file, key_pass_key, mode, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/observability_pipeline_websocket_source_tls_with_client_cert_mode.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
+  # TLS mode. Must be `with_client_cert`.
+  class ObservabilityPipelineWebsocketSourceTlsWithClientCertMode
+    include BaseEnumModel
+
+    WITH_CLIENT_CERT = "with_client_cert".freeze
+  end
+end