datadog_api_client 2.55.0 → 2.56.0

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

@@ -0,0 +1,379 @@
+=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 best practice associated with an insight. Populated with the first active best practice
+  # matched to the insight; `null` when no best practice is attached.
+  class GovernanceBestPracticeDefinition
+    include BaseGenericModel
+
+    # The value driver the best practice is grouped under, such as `access_governance`,
+    # `security`, `compliance`, or `operational_hygiene`.
+    attr_reader :category
+
+    # A relative link to the configuration page where the best practice can be acted upon.
+    attr_reader :deep_link
+
+    # The full rationale and guidance for the best practice.
+    attr_reader :description
+
+    # An optional association to a control's detection type. `null` when not associated with a control.
+    attr_accessor :detection_type
+
+    # The unique identifier of the best practice.
+    attr_reader :id
+
+    # The expected impact of following the best practice.
+    attr_reader :impact
+
+    # A priority hint for ordering best practices by expected impact. Lower values indicate
+    # higher priority.
+    attr_reader :impact_hint
+
+    # The permissions required for the user to act on the best practice.
+    attr_reader :permissions
+
+    # Whether the best practice is currently `active` or `deprecated`.
+    attr_reader :status
+
+    # A one-line explanation of why this best practice matters.
+    attr_reader :summary
+
+    # A short, human-readable name for the best practice.
+    attr_reader :title
+
+    # The condition that surfaces the best practice. For an `insight` trigger, the insight
+    # slug; for a `static` trigger, a descriptive condition key.
+    attr_reader :trigger_condition
+
+    # How the best practice is surfaced. `insight` ties it to an insight; `static` surfaces it
+    # unless its condition is met.
+    attr_reader :trigger_type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'category' => :'category',
+        :'deep_link' => :'deep_link',
+        :'description' => :'description',
+        :'detection_type' => :'detection_type',
+        :'id' => :'id',
+        :'impact' => :'impact',
+        :'impact_hint' => :'impact_hint',
+        :'permissions' => :'permissions',
+        :'status' => :'status',
+        :'summary' => :'summary',
+        :'title' => :'title',
+        :'trigger_condition' => :'trigger_condition',
+        :'trigger_type' => :'trigger_type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'category' => :'String',
+        :'deep_link' => :'String',
+        :'description' => :'String',
+        :'detection_type' => :'String',
+        :'id' => :'String',
+        :'impact' => :'String',
+        :'impact_hint' => :'Integer',
+        :'permissions' => :'Array<String>',
+        :'status' => :'String',
+        :'summary' => :'String',
+        :'title' => :'String',
+        :'trigger_condition' => :'String',
+        :'trigger_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'detection_type',
+      ])
+    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::GovernanceBestPracticeDefinition` 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?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'deep_link')
+        self.deep_link = attributes[:'deep_link']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'detection_type')
+        self.detection_type = attributes[:'detection_type']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'impact')
+        self.impact = attributes[:'impact']
+      end
+
+      if attributes.key?(:'impact_hint')
+        self.impact_hint = attributes[:'impact_hint']
+      end
+
+      if attributes.key?(:'permissions')
+        if (value = attributes[:'permissions']).is_a?(Array)
+          self.permissions = value
+        end
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'trigger_condition')
+        self.trigger_condition = attributes[:'trigger_condition']
+      end
+
+      if attributes.key?(:'trigger_type')
+        self.trigger_type = attributes[:'trigger_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 @category.nil?
+      return false if @deep_link.nil?
+      return false if @description.nil?
+      return false if @id.nil?
+      return false if @impact.nil?
+      return false if @impact_hint.nil?
+      return false if @permissions.nil?
+      return false if @status.nil?
+      return false if @summary.nil?
+      return false if @title.nil?
+      return false if @trigger_condition.nil?
+      return false if @trigger_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param category [Object] Object to be assigned
+    # @!visibility private
+    def category=(category)
+      if category.nil?
+        fail ArgumentError, 'invalid value for "category", category cannot be nil.'
+      end
+      @category = category
+    end
+
+    # Custom attribute writer method with validation
+    # @param deep_link [Object] Object to be assigned
+    # @!visibility private
+    def deep_link=(deep_link)
+      if deep_link.nil?
+        fail ArgumentError, 'invalid value for "deep_link", deep_link cannot be nil.'
+      end
+      @deep_link = deep_link
+    end
+
+    # Custom attribute writer method with validation
+    # @param description [Object] Object to be assigned
+    # @!visibility private
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'invalid value for "description", description cannot be nil.'
+      end
+      @description = description
+    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 impact [Object] Object to be assigned
+    # @!visibility private
+    def impact=(impact)
+      if impact.nil?
+        fail ArgumentError, 'invalid value for "impact", impact cannot be nil.'
+      end
+      @impact = impact
+    end
+
+    # Custom attribute writer method with validation
+    # @param impact_hint [Object] Object to be assigned
+    # @!visibility private
+    def impact_hint=(impact_hint)
+      if impact_hint.nil?
+        fail ArgumentError, 'invalid value for "impact_hint", impact_hint cannot be nil.'
+      end
+      @impact_hint = impact_hint
+    end
+
+    # Custom attribute writer method with validation
+    # @param permissions [Object] Object to be assigned
+    # @!visibility private
+    def permissions=(permissions)
+      if permissions.nil?
+        fail ArgumentError, 'invalid value for "permissions", permissions cannot be nil.'
+      end
+      @permissions = permissions
+    end
+
+    # Custom attribute writer method with validation
+    # @param status [Object] Object to be assigned
+    # @!visibility private
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'invalid value for "status", status cannot be nil.'
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param summary [Object] Object to be assigned
+    # @!visibility private
+    def summary=(summary)
+      if summary.nil?
+        fail ArgumentError, 'invalid value for "summary", summary cannot be nil.'
+      end
+      @summary = summary
+    end
+
+    # Custom attribute writer method with validation
+    # @param title [Object] Object to be assigned
+    # @!visibility private
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'invalid value for "title", title cannot be nil.'
+      end
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param trigger_condition [Object] Object to be assigned
+    # @!visibility private
+    def trigger_condition=(trigger_condition)
+      if trigger_condition.nil?
+        fail ArgumentError, 'invalid value for "trigger_condition", trigger_condition cannot be nil.'
+      end
+      @trigger_condition = trigger_condition
+    end
+
+    # Custom attribute writer method with validation
+    # @param trigger_type [Object] Object to be assigned
+    # @!visibility private
+    def trigger_type=(trigger_type)
+      if trigger_type.nil?
+        fail ArgumentError, 'invalid value for "trigger_type", trigger_type cannot be nil.'
+      end
+      @trigger_type = trigger_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 &&
+          category == o.category &&
+          deep_link == o.deep_link &&
+          description == o.description &&
+          detection_type == o.detection_type &&
+          id == o.id &&
+          impact == o.impact &&
+          impact_hint == o.impact_hint &&
+          permissions == o.permissions &&
+          status == o.status &&
+          summary == o.summary &&
+          title == o.title &&
+          trigger_condition == o.trigger_condition &&
+          trigger_type == o.trigger_type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [category, deep_link, description, detection_type, id, impact, impact_hint, permissions, status, summary, title, trigger_condition, trigger_type, additional_properties].hash
+    end
+  end
+end