volcano-sdk 0.5.2

data/lib/volcano/generated/lib/volcano-generated/models/frontend.rb

@@ -0,0 +1,504 @@
+=begin
+#Volcano Hosting API
+
+#Public API for Volcano Hosting clients, SDKs, and CLI tooling (Port 8000).  This specification intentionally excludes first-party/internal APIs. See api/openapi-internal.yaml for non-public internal and Builder operations.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@volcano.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Volcano::Generated
+  class Frontend < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :project_id
+
+    attr_accessor :name
+
+    attr_accessor :framework
+
+    # Optional relative POSIX path from the uploaded archive root to the Next.js app that is deployed.
+    attr_accessor :app_root
+
+    # Frontend lifecycle status. `degraded` means the regional runtime remains available but edge synchronization exhausted its immediate retries; Volcano retries edge recovery without rebuilding the frontend, and stops once a new deployment is queued or the retry budget runs out, leaving the frontend `degraded` until the next redeploy. A redeploy that fails over a serving frontend stays `active` on the previous deployment, so `failed` means no deployment is serving. 
+    attr_accessor :status
+
+    # Timestamp when the current provisioning phase started
+    attr_accessor :provisioning_started_at
+
+    attr_accessor :deployed_regions
+
+    # Identifier of the latest frontend deployment operation
+    attr_accessor :current_deployment_id
+
+    # Newest queued deployment that will run after the current operation
+    attr_accessor :pending_deployment_id
+
+    attr_accessor :site_url
+
+    # Active custom domain hostname when configured
+    attr_accessor :custom_domain
+
+    # Current custom domain lifecycle status
+    attr_accessor :custom_domain_status
+
+    attr_accessor :last_invoked_at
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'project_id' => :'project_id',
+        :'name' => :'name',
+        :'framework' => :'framework',
+        :'app_root' => :'app_root',
+        :'status' => :'status',
+        :'provisioning_started_at' => :'provisioning_started_at',
+        :'deployed_regions' => :'deployed_regions',
+        :'current_deployment_id' => :'current_deployment_id',
+        :'pending_deployment_id' => :'pending_deployment_id',
+        :'site_url' => :'site_url',
+        :'custom_domain' => :'custom_domain',
+        :'custom_domain_status' => :'custom_domain_status',
+        :'last_invoked_at' => :'last_invoked_at',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'project_id' => :'String',
+        :'name' => :'String',
+        :'framework' => :'String',
+        :'app_root' => :'String',
+        :'status' => :'String',
+        :'provisioning_started_at' => :'Time',
+        :'deployed_regions' => :'Array<String>',
+        :'current_deployment_id' => :'String',
+        :'pending_deployment_id' => :'String',
+        :'site_url' => :'String',
+        :'custom_domain' => :'String',
+        :'custom_domain_status' => :'String',
+        :'last_invoked_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Volcano::Generated::Frontend` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Volcano::Generated::Frontend`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'framework')
+        self.framework = attributes[:'framework']
+      else
+        self.framework = nil
+      end
+
+      if attributes.key?(:'app_root')
+        self.app_root = attributes[:'app_root']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'provisioning_started_at')
+        self.provisioning_started_at = attributes[:'provisioning_started_at']
+      end
+
+      if attributes.key?(:'deployed_regions')
+        if (value = attributes[:'deployed_regions']).is_a?(Array)
+          self.deployed_regions = value
+        end
+      else
+        self.deployed_regions = nil
+      end
+
+      if attributes.key?(:'current_deployment_id')
+        self.current_deployment_id = attributes[:'current_deployment_id']
+      end
+
+      if attributes.key?(:'pending_deployment_id')
+        self.pending_deployment_id = attributes[:'pending_deployment_id']
+      end
+
+      if attributes.key?(:'site_url')
+        self.site_url = attributes[:'site_url']
+      end
+
+      if attributes.key?(:'custom_domain')
+        self.custom_domain = attributes[:'custom_domain']
+      end
+
+      if attributes.key?(:'custom_domain_status')
+        self.custom_domain_status = attributes[:'custom_domain_status']
+      end
+
+      if attributes.key?(:'last_invoked_at')
+        self.last_invoked_at = attributes[:'last_invoked_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 63
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 63.')
+      end
+
+      pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @framework.nil?
+        invalid_properties.push('invalid value for "framework", framework cannot be nil.')
+      end
+
+      if !@app_root.nil? && @app_root.to_s.length > 1024
+        invalid_properties.push('invalid value for "app_root", the character length must be smaller than or equal to 1024.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @deployed_regions.nil?
+        invalid_properties.push('invalid value for "deployed_regions", deployed_regions cannot be nil.')
+      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
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @project_id.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 63
+      return false if @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/)
+      return false if @framework.nil?
+      framework_validator = EnumAttributeValidator.new('String', ["nextjs"])
+      return false unless framework_validator.valid?(@framework)
+      return false if !@app_root.nil? && @app_root.to_s.length > 1024
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["provisioning", "active", "degraded", "failed", "deleting"])
+      return false unless status_validator.valid?(@status)
+      return false if @deployed_regions.nil?
+      custom_domain_status_validator = EnumAttributeValidator.new('String', ["pending_verification", "provisioning", "active", "detaching", "failed", "deleted"])
+      return false unless custom_domain_status_validator.valid?(@custom_domain_status)
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    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
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      @project_id = project_id
+    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 > 63
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 63.'
+      end
+
+      pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] framework Object to be assigned
+    def framework=(framework)
+      validator = EnumAttributeValidator.new('String', ["nextjs"])
+      unless validator.valid?(framework)
+        fail ArgumentError, "invalid value for \"framework\", must be one of #{validator.allowable_values}."
+      end
+      @framework = framework
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] app_root Value to be assigned
+    def app_root=(app_root)
+      if app_root.nil?
+        fail ArgumentError, 'app_root cannot be nil'
+      end
+
+      if app_root.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "app_root", the character length must be smaller than or equal to 1024.'
+      end
+
+      @app_root = app_root
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["provisioning", "active", "degraded", "failed", "deleting"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] deployed_regions Value to be assigned
+    def deployed_regions=(deployed_regions)
+      if deployed_regions.nil?
+        fail ArgumentError, 'deployed_regions cannot be nil'
+      end
+
+      @deployed_regions = deployed_regions
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] custom_domain_status Object to be assigned
+    def custom_domain_status=(custom_domain_status)
+      validator = EnumAttributeValidator.new('String', ["pending_verification", "provisioning", "active", "detaching", "failed", "deleted"])
+      unless validator.valid?(custom_domain_status)
+        fail ArgumentError, "invalid value for \"custom_domain_status\", must be one of #{validator.allowable_values}."
+      end
+      @custom_domain_status = custom_domain_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          id == o.id &&
+          project_id == o.project_id &&
+          name == o.name &&
+          framework == o.framework &&
+          app_root == o.app_root &&
+          status == o.status &&
+          provisioning_started_at == o.provisioning_started_at &&
+          deployed_regions == o.deployed_regions &&
+          current_deployment_id == o.current_deployment_id &&
+          pending_deployment_id == o.pending_deployment_id &&
+          site_url == o.site_url &&
+          custom_domain == o.custom_domain &&
+          custom_domain_status == o.custom_domain_status &&
+          last_invoked_at == o.last_invoked_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, project_id, name, framework, app_root, status, provisioning_started_at, deployed_regions, current_deployment_id, pending_deployment_id, site_url, custom_domain, custom_domain_status, last_invoked_at, created_at, updated_at].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end