fastly 17.2.0 → 18.0.0

data/lib/fastly/models/network_protect_network_response.rb

@@ -0,0 +1,477 @@
+=begin
+#Fastly API
+
+#Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
+
+The version of the OpenAPI document: 1.0.0
+Contact: oss@fastly.com
+
+=end
+
+require 'date'
+require 'time'
+
+module Fastly
+  # A Network Protect network response.
+  class NetworkProtectNetworkResponse
+    # A human-readable name, unique within the customer.
+    attr_accessor :name
+
+    # The CIDR block to protect, masked to its network address. It cannot be changed after creation.
+    attr_accessor :prefix
+
+    # Complete endpoint policy configuration. A network has at most one policy per region and may have no policies.
+    attr_accessor :endpoint_policies
+
+    # Desired advertisement state, which is not the same as observed route state. Enabling it requires approved LOA, valid ROA, and a ready default-region delivery policy. A later ROA failure does not turn an existing advertisement off; losing LOA approval or the last ready default endpoint does.
+    attr_accessor :advertise
+
+    # A read-only unique identifier for a Network Protect resource.
+    attr_accessor :id
+
+    # An ISO 8601 timestamp in UTC.
+    attr_accessor :created_at
+
+    # An ISO 8601 timestamp in UTC.
+    attr_accessor :updated_at
+
+    # Optional descriptive text for the network. This metadata does not change traffic handling. Null clears it on update.
+    attr_accessor :description
+
+    # The backend-assigned rule set applied to this network.
+    attr_accessor :rule_set_id
+
+    attr_accessor :roa_status
+
+    # When Fastly last completed a ROA check. Null while the status is pending. A failed check leaves this unchanged; an old value can indicate delayed or failing checks. Null also means the controller did not report a check time.
+    attr_accessor :roa_checked_at
+
+    # When the RPKI dataset used by the last check was built. This is not the same as `roa_checked_at`; a recent check can use an older dataset. Null while the status is pending or when no dataset build time was reported.
+    attr_accessor :roa_data_as_of
+
+    attr_accessor :loa_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'prefix' => :'prefix',
+        :'endpoint_policies' => :'endpoint_policies',
+        :'advertise' => :'advertise',
+        :'id' => :'id',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'description' => :'description',
+        :'rule_set_id' => :'rule_set_id',
+        :'roa_status' => :'roa_status',
+        :'roa_checked_at' => :'roa_checked_at',
+        :'roa_data_as_of' => :'roa_data_as_of',
+        :'loa_status' => :'loa_status'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.fastly_types
+      {
+        :'name' => :'String',
+        :'prefix' => :'String',
+        :'endpoint_policies' => :'Array<NetworkProtectEndpointPolicy>',
+        :'advertise' => :'Boolean',
+        :'id' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'description' => :'String',
+        :'rule_set_id' => :'String',
+        :'roa_status' => :'NetworkProtectRoaStatus',
+        :'roa_checked_at' => :'Time',
+        :'roa_data_as_of' => :'Time',
+        :'loa_status' => :'NetworkProtectLoaStatus'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.fastly_nullable
+      Set.new([
+        :'description',
+        :'rule_set_id',
+        :'roa_checked_at',
+        :'roa_data_as_of',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.fastly_all_of
+      [
+      :'NetworkProtectNetwork',
+      :'NetworkProtectNetworkResponseFields'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::NetworkProtectNetworkResponse` 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 `Fastly::NetworkProtectNetworkResponse`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'prefix')
+        self.prefix = attributes[:'prefix']
+      end
+
+      if attributes.key?(:'endpoint_policies')
+        if (value = attributes[:'endpoint_policies']).is_a?(Array)
+          self.endpoint_policies = value
+        end
+      end
+
+      if attributes.key?(:'advertise')
+        self.advertise = attributes[:'advertise']
+      else
+        self.advertise = false
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'rule_set_id')
+        self.rule_set_id = attributes[:'rule_set_id']
+      end
+
+      if attributes.key?(:'roa_status')
+        self.roa_status = attributes[:'roa_status']
+      end
+
+      if attributes.key?(:'roa_checked_at')
+        self.roa_checked_at = attributes[:'roa_checked_at']
+      end
+
+      if attributes.key?(:'roa_data_as_of')
+        self.roa_data_as_of = attributes[:'roa_data_as_of']
+      end
+
+      if attributes.key?(:'loa_status')
+        self.loa_status = attributes[:'loa_status']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @prefix.nil?
+        invalid_properties.push('invalid value for "prefix", prefix cannot be nil.')
+      end
+
+      if @endpoint_policies.nil?
+        invalid_properties.push('invalid value for "endpoint_policies", endpoint_policies cannot be nil.')
+      end
+
+      if @advertise.nil?
+        invalid_properties.push('invalid value for "advertise", advertise cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9]{19,22}$/)
+      if @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if !@description.nil? && @description.to_s.length > 1024
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 1024.')
+      end
+
+      if !@description.nil? && @description.to_s.length < 1
+        invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9]{19,22}$/)
+      if !@rule_set_id.nil? && @rule_set_id !~ pattern
+        invalid_properties.push("invalid value for \"rule_set_id\", must conform to the pattern #{pattern}.")
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @name.to_s.length < 1
+      return false if @prefix.nil?
+      return false if @endpoint_policies.nil?
+      return false if @advertise.nil?
+      return false if @id.nil?
+      return false if @id !~ Regexp.new(/^[A-Za-z0-9]{19,22}$/)
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      return false if !@description.nil? && @description.to_s.length > 1024
+      return false if !@description.nil? && @description.to_s.length < 1
+      return false if !@rule_set_id.nil? && @rule_set_id !~ Regexp.new(/^[A-Za-z0-9]{19,22}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9]{19,22}$/)
+      if id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 1024.'
+      end
+
+      if !description.nil? && description.to_s.length < 1
+        fail ArgumentError, 'invalid value for "description", the character length must be great than or equal to 1.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rule_set_id Value to be assigned
+    def rule_set_id=(rule_set_id)
+      pattern = Regexp.new(/^[A-Za-z0-9]{19,22}$/)
+      if !rule_set_id.nil? && rule_set_id !~ pattern
+        fail ArgumentError, "invalid value for \"rule_set_id\", must conform to the pattern #{pattern}."
+      end
+
+      @rule_set_id = rule_set_id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          prefix == o.prefix &&
+          endpoint_policies == o.endpoint_policies &&
+          advertise == o.advertise &&
+          id == o.id &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          description == o.description &&
+          rule_set_id == o.rule_set_id &&
+          roa_status == o.roa_status &&
+          roa_checked_at == o.roa_checked_at &&
+          roa_data_as_of == o.roa_data_as_of &&
+          loa_status == o.loa_status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [name, prefix, endpoint_policies, advertise, id, created_at, updated_at, description, rule_set_id, roa_status, roa_checked_at, roa_data_as_of, loa_status].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.fastly_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Fastly.const_get(type)
+        klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.fastly_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end