volcano-sdk 0.5.2

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

@@ -0,0 +1,442 @@
+=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
+  # PostgreSQL database with automatic scalability and security features. 
+  class Database < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :project_id
+
+    # Database name
+    attr_accessor :name
+
+    # Database status. `restoring` means a restore is replacing the database's data: it does not accept connections, and the operations that would race the restore are rejected until it finishes. Its branches keep serving throughout. 
+    attr_accessor :status
+
+    # Timestamp when the current provisioning phase started
+    attr_accessor :provisioning_started_at
+
+    # Secure PostgreSQL connection URI for your database.  The database is identified by the globally-unique username (`volcano_client_{database_id}`) already in this URI; the `application_name` parameter only selects the access mode: - `volcano_full_access` — Full admin access (DDL, migrations) - `volcano_user_access:{user_id}` — User impersonation (RLS enforced) - `volcano_user_access` — Anonymous access (anon role, RLS enforced) 
+    attr_accessor :connection_string
+
+    # Region where the database is hosted
+    attr_accessor :region
+
+    # PostgreSQL major version
+    attr_accessor :pg_version
+
+    # Database size tier that determines available RAM and scaling limits. 
+    attr_accessor :database_type
+
+    # Latest observed storage for this database, in bytes: its own on-disk size, plus what each branch has diverged from it, plus what its backups cost to hold. This is the figure the storage allowance is enforced against, and the stats endpoint breaks it down. A point-in-time gauge recorded by a background pass, so it may be absent until the database has been sampled, and it can trail the stats endpoint's `current_storage_bytes`, which measures on request. Summing the latest samples for every database in a project produces the project's \"Database Storage (Bytes)\" usage gauge. Populated on database list responses; single-database responses omit it. 
+    attr_accessor :storage_bytes
+
+    # Most recent request timestamp for this database
+    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',
+        :'status' => :'status',
+        :'provisioning_started_at' => :'provisioning_started_at',
+        :'connection_string' => :'connection_string',
+        :'region' => :'region',
+        :'pg_version' => :'pg_version',
+        :'database_type' => :'database_type',
+        :'storage_bytes' => :'storage_bytes',
+        :'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',
+        :'status' => :'String',
+        :'provisioning_started_at' => :'Time',
+        :'connection_string' => :'String',
+        :'region' => :'String',
+        :'pg_version' => :'String',
+        :'database_type' => :'String',
+        :'storage_bytes' => :'Integer',
+        :'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::Database` 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::Database`. 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?(:'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?(:'connection_string')
+        self.connection_string = attributes[:'connection_string']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'pg_version')
+        self.pg_version = attributes[:'pg_version']
+      end
+
+      if attributes.key?(:'database_type')
+        self.database_type = attributes[:'database_type']
+      end
+
+      if attributes.key?(:'storage_bytes')
+        self.storage_bytes = attributes[:'storage_bytes']
+      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 > 64
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 64.')
+      end
+
+      pattern = Regexp.new(/^[a-z0-9_]+$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if !@storage_bytes.nil? && @storage_bytes < 0
+        invalid_properties.push('invalid value for "storage_bytes", must be greater than or equal to 0.')
+      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 > 64
+      return false if @name !~ Regexp.new(/^[a-z0-9_]+$/)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["provisioning", "active", "failed", "restoring", "deleting"])
+      return false unless status_validator.valid?(@status)
+      database_type_validator = EnumAttributeValidator.new('String', ["volcano-db-xs", "volcano-db-s", "volcano-db-m", "volcano-db-l", "volcano-db-xl", "volcano-db-2xl"])
+      return false unless database_type_validator.valid?(@database_type)
+      return false if !@storage_bytes.nil? && @storage_bytes < 0
+      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 > 64
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 64.'
+      end
+
+      pattern = Regexp.new(/^[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] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["provisioning", "active", "failed", "restoring", "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 checking allowed values (enum).
+    # @param [Object] database_type Object to be assigned
+    def database_type=(database_type)
+      validator = EnumAttributeValidator.new('String', ["volcano-db-xs", "volcano-db-s", "volcano-db-m", "volcano-db-l", "volcano-db-xl", "volcano-db-2xl"])
+      unless validator.valid?(database_type)
+        fail ArgumentError, "invalid value for \"database_type\", must be one of #{validator.allowable_values}."
+      end
+      @database_type = database_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] storage_bytes Value to be assigned
+    def storage_bytes=(storage_bytes)
+      if storage_bytes.nil?
+        fail ArgumentError, 'storage_bytes cannot be nil'
+      end
+
+      if storage_bytes < 0
+        fail ArgumentError, 'invalid value for "storage_bytes", must be greater than or equal to 0.'
+      end
+
+      @storage_bytes = storage_bytes
+    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 &&
+          status == o.status &&
+          provisioning_started_at == o.provisioning_started_at &&
+          connection_string == o.connection_string &&
+          region == o.region &&
+          pg_version == o.pg_version &&
+          database_type == o.database_type &&
+          storage_bytes == o.storage_bytes &&
+          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, status, provisioning_started_at, connection_string, region, pg_version, database_type, storage_bytes, 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