datadog_api_client 2.8.0 → 2.10.0

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

@@ -0,0 +1,228 @@
+=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
+  # The metadata object associated with how a dashboard has been/will be shared.
+  class SharedDashboard
+    include BaseGenericModel
+
+    # Whether the object has unparsed attributes
+    # @!visibility private
+    attr_accessor :_unparsed
+
+    # User who shared the dashboard.
+    attr_accessor :author
+
+    # Date the dashboard was shared.
+    attr_accessor :created_at
+
+    # ID of the dashboard to share.
+    attr_reader :dashboard_id
+
+    # The type of the associated private dashboard.
+    attr_reader :dashboard_type
+
+    # Object containing the live span selection for the dashboard.
+    attr_accessor :global_time
+
+    # Whether to allow viewers to select a different global time setting for the shared dashboard.
+    attr_accessor :global_time_selectable_enabled
+
+    # URL of the shared dashboard.
+    attr_accessor :public_url
+
+    # List of objects representing template variables on the shared dashboard which can have selectable values.
+    attr_accessor :selectable_template_vars
+
+    # List of email addresses that can receive an invitation to access to the shared dashboard.
+    attr_accessor :share_list
+
+    # Type of sharing access (either open to anyone who has the public URL or invite-only).
+    attr_accessor :share_type
+
+    # A unique token assigned to the shared dashboard.
+    attr_accessor :token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'author' => :'author',
+        :'created_at' => :'created_at',
+        :'dashboard_id' => :'dashboard_id',
+        :'dashboard_type' => :'dashboard_type',
+        :'global_time' => :'global_time',
+        :'global_time_selectable_enabled' => :'global_time_selectable_enabled',
+        :'public_url' => :'public_url',
+        :'selectable_template_vars' => :'selectable_template_vars',
+        :'share_list' => :'share_list',
+        :'share_type' => :'share_type',
+        :'token' => :'token'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'author' => :'SharedDashboardAuthor',
+        :'created_at' => :'Time',
+        :'dashboard_id' => :'String',
+        :'dashboard_type' => :'DashboardType',
+        :'global_time' => :'DashboardGlobalTime',
+        :'global_time_selectable_enabled' => :'Boolean',
+        :'public_url' => :'String',
+        :'selectable_template_vars' => :'Array<SelectableTemplateVariableItems>',
+        :'share_list' => :'Array<String>',
+        :'share_type' => :'DashboardShareType',
+        :'token' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'global_time_selectable_enabled',
+        :'selectable_template_vars',
+        :'share_list',
+        :'share_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::V1::SharedDashboard` 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::V1::SharedDashboard`. 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?(:'author')
+        self.author = attributes[:'author']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'dashboard_id')
+        self.dashboard_id = attributes[:'dashboard_id']
+      end
+
+      if attributes.key?(:'dashboard_type')
+        self.dashboard_type = attributes[:'dashboard_type']
+      end
+
+      if attributes.key?(:'global_time')
+        self.global_time = attributes[:'global_time']
+      end
+
+      if attributes.key?(:'global_time_selectable_enabled')
+        self.global_time_selectable_enabled = attributes[:'global_time_selectable_enabled']
+      end
+
+      if attributes.key?(:'public_url')
+        self.public_url = attributes[:'public_url']
+      end
+
+      if attributes.key?(:'selectable_template_vars')
+        if (value = attributes[:'selectable_template_vars']).is_a?(Array)
+          self.selectable_template_vars = value
+        end
+      end
+
+      if attributes.key?(:'share_list')
+        if (value = attributes[:'share_list']).is_a?(Array)
+          self.share_list = value
+        end
+      end
+
+      if attributes.key?(:'share_type')
+        self.share_type = attributes[:'share_type']
+      end
+
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
+      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 @dashboard_id.nil?
+      return false if @dashboard_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param dashboard_id [Object] Object to be assigned
+    # @!visibility private
+    def dashboard_id=(dashboard_id)
+      if dashboard_id.nil?
+        fail ArgumentError, 'invalid value for "dashboard_id", dashboard_id cannot be nil.'
+      end
+      @dashboard_id = dashboard_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param dashboard_type [Object] Object to be assigned
+    # @!visibility private
+    def dashboard_type=(dashboard_type)
+      if dashboard_type.nil?
+        fail ArgumentError, 'invalid value for "dashboard_type", dashboard_type cannot be nil.'
+      end
+      @dashboard_type = dashboard_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 &&
+          author == o.author &&
+          created_at == o.created_at &&
+          dashboard_id == o.dashboard_id &&
+          dashboard_type == o.dashboard_type &&
+          global_time == o.global_time &&
+          global_time_selectable_enabled == o.global_time_selectable_enabled &&
+          public_url == o.public_url &&
+          selectable_template_vars == o.selectable_template_vars &&
+          share_list == o.share_list &&
+          share_type == o.share_type &&
+          token == o.token
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [author, created_at, dashboard_id, dashboard_type, global_time, global_time_selectable_enabled, public_url, selectable_template_vars, share_list, share_type, token].hash
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+=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
+  # User who shared the dashboard.
+  class SharedDashboardAuthor
+    include BaseGenericModel
+
+    # Whether the object has unparsed attributes
+    # @!visibility private
+    attr_accessor :_unparsed
+
+    # Identifier of the user who shared the dashboard.
+    attr_accessor :handle
+
+    # Name of the user who shared the dashboard.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'handle' => :'handle',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'handle' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+      ])
+    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::SharedDashboardAuthor` 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::V1::SharedDashboardAuthor`. 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?(:'handle')
+        self.handle = attributes[:'handle']
+      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?
+      true
+    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 &&
+          handle == o.handle &&
+          name == o.name
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [handle, name].hash
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+=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
+  # Invitations data and metadata that exists for a shared dashboard returned by the API.
+  class SharedDashboardInvites
+    include BaseGenericModel
+
+    # Whether the object has unparsed attributes
+    # @!visibility private
+    attr_accessor :_unparsed
+
+    # An object or list of objects containing the information for an invitation to a shared dashboard.
+    attr_reader :data
+
+    # Pagination metadata returned by the API.
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'SharedDashboardInvitesData',
+        :'meta' => :'SharedDashboardInvitesMeta'
+      }
+    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::SharedDashboardInvites` 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::V1::SharedDashboardInvites`. 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?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param data [Object] Object to be assigned
+    # @!visibility private
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'invalid value for "data", data cannot be nil.'
+      end
+      @data = data
+    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 &&
+          data == o.data &&
+          meta == o.meta
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data, meta].hash
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+=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
+  # An object or list of objects containing the information for an invitation to a shared dashboard.
+  module SharedDashboardInvitesData
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'SharedDashboardInvitesDataObject',
+          :'Array<SharedDashboardInvitesDataObject>'
+        ]
+      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/v1/models/shared_dashboard_invites_data_object.rb

@@ -0,0 +1,123 @@
+=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 containing the information for an invitation to a shared dashboard.
+  class SharedDashboardInvitesDataObject
+    include BaseGenericModel
+
+    # Whether the object has unparsed attributes
+    # @!visibility private
+    attr_accessor :_unparsed
+
+    # Attributes of the shared dashboard invitation
+    attr_reader :attributes
+
+    # Type for shared dashboard invitation request body.
+    attr_reader :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'attributes' => :'SharedDashboardInvitesDataObjectAttributes',
+        :'type' => :'DashboardInviteType'
+      }
+    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::SharedDashboardInvitesDataObject` 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::V1::SharedDashboardInvitesDataObject`. 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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      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 @attributes.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param attributes [Object] Object to be assigned
+    # @!visibility private
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'invalid value for "attributes", attributes cannot be nil.'
+      end
+      @attributes = attributes
+    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 &&
+          attributes == o.attributes &&
+          type == o.type
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [attributes, type].hash
+    end
+  end
+end