volcano-sdk 0.5.2

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

@@ -0,0 +1,223 @@
+=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 CreateDatabaseBranchRequest < ApiModelBase
+    # Branch name (must be unique within the parent database)
+    attr_accessor :name
+
+    # How long the branch should live, between one hour and 30 days. Defaults to 7 days when omitted. 
+    attr_accessor :ttl_seconds
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'ttl_seconds' => :'ttl_seconds'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'ttl_seconds' => :'Integer'
+      }
+    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::CreateDatabaseBranchRequest` 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::CreateDatabaseBranchRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'ttl_seconds')
+        self.ttl_seconds = attributes[:'ttl_seconds']
+      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 @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 !@ttl_seconds.nil? && @ttl_seconds > 2592000
+        invalid_properties.push('invalid value for "ttl_seconds", must be smaller than or equal to 2592000.')
+      end
+
+      if !@ttl_seconds.nil? && @ttl_seconds < 3600
+        invalid_properties.push('invalid value for "ttl_seconds", must be greater than or equal to 3600.')
+      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 @name.nil?
+      return false if @name.to_s.length > 64
+      return false if @name !~ Regexp.new(/^[a-z0-9_]+$/)
+      return false if !@ttl_seconds.nil? && @ttl_seconds > 2592000
+      return false if !@ttl_seconds.nil? && @ttl_seconds < 3600
+      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 > 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 with validation
+    # @param [Object] ttl_seconds Value to be assigned
+    def ttl_seconds=(ttl_seconds)
+      if ttl_seconds.nil?
+        fail ArgumentError, 'ttl_seconds cannot be nil'
+      end
+
+      if ttl_seconds > 2592000
+        fail ArgumentError, 'invalid value for "ttl_seconds", must be smaller than or equal to 2592000.'
+      end
+
+      if ttl_seconds < 3600
+        fail ArgumentError, 'invalid value for "ttl_seconds", must be greater than or equal to 3600.'
+      end
+
+      @ttl_seconds = ttl_seconds
+    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 &&
+          ttl_seconds == o.ttl_seconds
+    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, ttl_seconds].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

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

@@ -0,0 +1,290 @@
+=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
+  # Create a new PostgreSQL database. Volcano automatically sets up: - Auth helpers (auth.uid(), auth.email(), auth.role()) - Database roles (anon for unauthenticated, authenticated for signed-in users) - Secure multi-tenant isolation - Ready for Row-Level Security 
+  class CreateDatabaseRequest < ApiModelBase
+    # Database name (must be unique within project)
+    attr_accessor :name
+
+    # Region for database hosting
+    attr_accessor :region
+
+    # PostgreSQL major version
+    attr_accessor :pg_version
+
+    # Compute size tier (optional, defaults to volcano-db-xs). Determines autoscaling limits for the database. 
+    attr_accessor :database_type
+
+    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
+      {
+        :'name' => :'name',
+        :'region' => :'region',
+        :'pg_version' => :'pg_version',
+        :'database_type' => :'database_type'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'region' => :'String',
+        :'pg_version' => :'String',
+        :'database_type' => :'String'
+      }
+    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::CreateDatabaseRequest` 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::CreateDatabaseRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      else
+        self.region = nil
+      end
+
+      if attributes.key?(:'pg_version')
+        self.pg_version = attributes[:'pg_version']
+      else
+        self.pg_version = nil
+      end
+
+      if attributes.key?(:'database_type')
+        self.database_type = attributes[:'database_type']
+      else
+        self.database_type = 'volcano-db-xs'
+      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 @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 @region.nil?
+        invalid_properties.push('invalid value for "region", region cannot be nil.')
+      end
+
+      if @pg_version.nil?
+        invalid_properties.push('invalid value for "pg_version", pg_version 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 @name.nil?
+      return false if @name.to_s.length > 64
+      return false if @name !~ Regexp.new(/^[a-z0-9_]+$/)
+      return false if @region.nil?
+      region_validator = EnumAttributeValidator.new('String', ["aws-us-east-1", "aws-us-east-2", "aws-us-west-2", "aws-eu-central-1", "aws-eu-west-2", "aws-ap-southeast-1", "aws-ap-southeast-2", "aws-sa-east-1"])
+      return false unless region_validator.valid?(@region)
+      return false if @pg_version.nil?
+      pg_version_validator = EnumAttributeValidator.new('String', ["15", "16"])
+      return false unless pg_version_validator.valid?(@pg_version)
+      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)
+      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 > 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] region Object to be assigned
+    def region=(region)
+      validator = EnumAttributeValidator.new('String', ["aws-us-east-1", "aws-us-east-2", "aws-us-west-2", "aws-eu-central-1", "aws-eu-west-2", "aws-ap-southeast-1", "aws-ap-southeast-2", "aws-sa-east-1"])
+      unless validator.valid?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{validator.allowable_values}."
+      end
+      @region = region
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pg_version Object to be assigned
+    def pg_version=(pg_version)
+      validator = EnumAttributeValidator.new('String', ["15", "16"])
+      unless validator.valid?(pg_version)
+        fail ArgumentError, "invalid value for \"pg_version\", must be one of #{validator.allowable_values}."
+      end
+      @pg_version = pg_version
+    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
+
+    # 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 &&
+          region == o.region &&
+          pg_version == o.pg_version &&
+          database_type == o.database_type
+    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, region, pg_version, database_type].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

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

@@ -0,0 +1,187 @@
+=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
+  # Names what to restore. Supply exactly one of `backup_name` or `restore_to`. 
+  class CreateDatabaseRestoreRequest < ApiModelBase
+    # A backup of this database to restore, exactly as returned by the list endpoint.  Deliberately looser than the names you can create, like the backup path parameter: a backup made by a schedule is named for you, so restoring one accepts any name a backup can have. 
+    attr_accessor :backup_name
+
+    # A point in time to restore to, which must fall inside the `restore_window` reported when listing backups. 
+    attr_accessor :restore_to
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'backup_name' => :'backup_name',
+        :'restore_to' => :'restore_to'
+      }
+    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
+      {
+        :'backup_name' => :'String',
+        :'restore_to' => :'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::CreateDatabaseRestoreRequest` 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::CreateDatabaseRestoreRequest`. 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?(:'backup_name')
+        self.backup_name = attributes[:'backup_name']
+      end
+
+      if attributes.key?(:'restore_to')
+        self.restore_to = attributes[:'restore_to']
+      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 !@backup_name.nil? && @backup_name.to_s.length > 128
+        invalid_properties.push('invalid value for "backup_name", the character length must be smaller than or equal to 128.')
+      end
+
+      if !@backup_name.nil? && @backup_name.to_s.length < 1
+        invalid_properties.push('invalid value for "backup_name", the character length must be greater than or equal to 1.')
+      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 !@backup_name.nil? && @backup_name.to_s.length > 128
+      return false if !@backup_name.nil? && @backup_name.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] backup_name Value to be assigned
+    def backup_name=(backup_name)
+      if backup_name.nil?
+        fail ArgumentError, 'backup_name cannot be nil'
+      end
+
+      if backup_name.to_s.length > 128
+        fail ArgumentError, 'invalid value for "backup_name", the character length must be smaller than or equal to 128.'
+      end
+
+      if backup_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "backup_name", the character length must be greater than or equal to 1.'
+      end
+
+      @backup_name = backup_name
+    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 &&
+          backup_name == o.backup_name &&
+          restore_to == o.restore_to
+    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
+      [backup_name, restore_to].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