turnkey_client 0.0.18 → 0.0.19

data/lib/turnkey_client/models/create_tvc_deployment_intent.rb

@@ -30,23 +30,22 @@ module TurnkeyClient
     # Digest of the pivot binary in the pivot container. This value will be inserted in the QOS manifest to ensure application integrity.
     attr_accessor :expected_pivot_digest
 
-    # URL of the container containing the host binary
-    attr_accessor :host_container_image_url
-
-    # Location of the binary inside the host container
-    attr_accessor :host_path
-
-    # Arguments to pass to the host binary at startup. Encoded as a list of strings, for example [\"--foo\", \"bar\"]
-    attr_accessor :host_args
-
     # Optional nonce to ensure uniqueness of the deployment manifest. If not provided, it defaults to the current Unix timestamp in seconds.
     attr_accessor :nonce
 
     # Optional encrypted pull secret to authorize Turnkey to pull the pivot container image. If your image is public, leave this empty.
     attr_accessor :pivot_container_encrypted_pull_secret
 
-    # Optional encrypted pull secret to authorize Turnkey to pull the host container image. If your image is public, leave this empty.
-    attr_accessor :host_container_encrypted_pull_secret
+    # Optional flag to indicate whether to deploy the TVC app in debug mode, which includes additional logging and debugging tools. Default is false.
+    attr_accessor :debug_mode
+
+    attr_accessor :health_check_type
+
+    # Port to use for health checks.
+    attr_accessor :health_check_port
+
+    # Port to use for public ingress.
+    attr_accessor :public_ingress_port
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -57,12 +56,12 @@ module TurnkeyClient
         :'pivot_path' => :'pivotPath',
         :'pivot_args' => :'pivotArgs',
         :'expected_pivot_digest' => :'expectedPivotDigest',
-        :'host_container_image_url' => :'hostContainerImageUrl',
-        :'host_path' => :'hostPath',
-        :'host_args' => :'hostArgs',
         :'nonce' => :'nonce',
         :'pivot_container_encrypted_pull_secret' => :'pivotContainerEncryptedPullSecret',
-        :'host_container_encrypted_pull_secret' => :'hostContainerEncryptedPullSecret'
+        :'debug_mode' => :'debugMode',
+        :'health_check_type' => :'healthCheckType',
+        :'health_check_port' => :'healthCheckPort',
+        :'public_ingress_port' => :'publicIngressPort'
       }
     end
 
@@ -75,12 +74,12 @@ module TurnkeyClient
         :'pivot_path' => :'Object',
         :'pivot_args' => :'Object',
         :'expected_pivot_digest' => :'Object',
-        :'host_container_image_url' => :'Object',
-        :'host_path' => :'Object',
-        :'host_args' => :'Object',
         :'nonce' => :'Object',
         :'pivot_container_encrypted_pull_secret' => :'Object',
-        :'host_container_encrypted_pull_secret' => :'Object'
+        :'debug_mode' => :'Object',
+        :'health_check_type' => :'Object',
+        :'health_check_port' => :'Object',
+        :'public_ingress_port' => :'Object'
       }
     end
 
@@ -89,7 +88,7 @@ module TurnkeyClient
       Set.new([
         :'nonce',
         :'pivot_container_encrypted_pull_secret',
-        :'host_container_encrypted_pull_secret'
+        :'debug_mode',
       ])
     end
   
@@ -134,30 +133,28 @@ module TurnkeyClient
         self.expected_pivot_digest = attributes[:'expected_pivot_digest']
       end
 
-      if attributes.key?(:'host_container_image_url')
-        self.host_container_image_url = attributes[:'host_container_image_url']
+      if attributes.key?(:'nonce')
+        self.nonce = attributes[:'nonce']
       end
 
-      if attributes.key?(:'host_path')
-        self.host_path = attributes[:'host_path']
+      if attributes.key?(:'pivot_container_encrypted_pull_secret')
+        self.pivot_container_encrypted_pull_secret = attributes[:'pivot_container_encrypted_pull_secret']
       end
 
-      if attributes.key?(:'host_args')
-        if (value = attributes[:'host_args']).is_a?(Array)
-          self.host_args = value
-        end
+      if attributes.key?(:'debug_mode')
+        self.debug_mode = attributes[:'debug_mode']
       end
 
-      if attributes.key?(:'nonce')
-        self.nonce = attributes[:'nonce']
+      if attributes.key?(:'health_check_type')
+        self.health_check_type = attributes[:'health_check_type']
       end
 
-      if attributes.key?(:'pivot_container_encrypted_pull_secret')
-        self.pivot_container_encrypted_pull_secret = attributes[:'pivot_container_encrypted_pull_secret']
+      if attributes.key?(:'health_check_port')
+        self.health_check_port = attributes[:'health_check_port']
       end
 
-      if attributes.key?(:'host_container_encrypted_pull_secret')
-        self.host_container_encrypted_pull_secret = attributes[:'host_container_encrypted_pull_secret']
+      if attributes.key?(:'public_ingress_port')
+        self.public_ingress_port = attributes[:'public_ingress_port']
       end
     end
 
@@ -189,16 +186,16 @@ module TurnkeyClient
         invalid_properties.push('invalid value for "expected_pivot_digest", expected_pivot_digest cannot be nil.')
       end
 
-      if @host_container_image_url.nil?
-        invalid_properties.push('invalid value for "host_container_image_url", host_container_image_url cannot be nil.')
+      if @health_check_type.nil?
+        invalid_properties.push('invalid value for "health_check_type", health_check_type cannot be nil.')
       end
 
-      if @host_path.nil?
-        invalid_properties.push('invalid value for "host_path", host_path cannot be nil.')
+      if @health_check_port.nil?
+        invalid_properties.push('invalid value for "health_check_port", health_check_port cannot be nil.')
       end
 
-      if @host_args.nil?
-        invalid_properties.push('invalid value for "host_args", host_args cannot be nil.')
+      if @public_ingress_port.nil?
+        invalid_properties.push('invalid value for "public_ingress_port", public_ingress_port cannot be nil.')
       end
 
       invalid_properties
@@ -213,9 +210,9 @@ module TurnkeyClient
       return false if @pivot_path.nil?
       return false if @pivot_args.nil?
       return false if @expected_pivot_digest.nil?
-      return false if @host_container_image_url.nil?
-      return false if @host_path.nil?
-      return false if @host_args.nil?
+      return false if @health_check_type.nil?
+      return false if @health_check_port.nil?
+      return false if @public_ingress_port.nil?
       true
     end
 
@@ -230,12 +227,12 @@ module TurnkeyClient
           pivot_path == o.pivot_path &&
           pivot_args == o.pivot_args &&
           expected_pivot_digest == o.expected_pivot_digest &&
-          host_container_image_url == o.host_container_image_url &&
-          host_path == o.host_path &&
-          host_args == o.host_args &&
           nonce == o.nonce &&
           pivot_container_encrypted_pull_secret == o.pivot_container_encrypted_pull_secret &&
-          host_container_encrypted_pull_secret == o.host_container_encrypted_pull_secret
+          debug_mode == o.debug_mode &&
+          health_check_type == o.health_check_type &&
+          health_check_port == o.health_check_port &&
+          public_ingress_port == o.public_ingress_port
     end
 
     # @see the `==` method
@@ -247,7 +244,7 @@ module TurnkeyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [app_id, qos_version, pivot_container_image_url, pivot_path, pivot_args, expected_pivot_digest, host_container_image_url, host_path, host_args, nonce, pivot_container_encrypted_pull_secret, host_container_encrypted_pull_secret].hash
+      [app_id, qos_version, pivot_container_image_url, pivot_path, pivot_args, expected_pivot_digest, nonce, pivot_container_encrypted_pull_secret, debug_mode, health_check_type, health_check_port, public_ingress_port].hash
     end
 
     # Builds the object from hash

data/lib/turnkey_client/models/create_tvc_deployment_request.rb

@@ -0,0 +1,288 @@
+=begin
+#API Reference
+
+#Review our [API Introduction](../api-introduction) to get started.
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+=end
+
+require 'date'
+
+module TurnkeyClient
+  class CreateTvcDeploymentRequest
+    attr_accessor :type
+
+    # Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
+    attr_accessor :timestamp_ms
+
+    # Unique identifier for a given Organization.
+    attr_accessor :organization_id
+
+    attr_accessor :parameters
+
+    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
+      {
+        :'type' => :'type',
+        :'timestamp_ms' => :'timestampMs',
+        :'organization_id' => :'organizationId',
+        :'parameters' => :'parameters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'Object',
+        :'timestamp_ms' => :'Object',
+        :'organization_id' => :'Object',
+        :'parameters' => :'Object'
+      }
+    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 `TurnkeyClient::CreateTvcDeploymentRequest` 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 `TurnkeyClient::CreateTvcDeploymentRequest`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'timestamp_ms')
+        self.timestamp_ms = attributes[:'timestamp_ms']
+      end
+
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      end
+
+      if attributes.key?(:'parameters')
+        self.parameters = attributes[:'parameters']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @timestamp_ms.nil?
+        invalid_properties.push('invalid value for "timestamp_ms", timestamp_ms cannot be nil.')
+      end
+
+      if @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      end
+
+      if @parameters.nil?
+        invalid_properties.push('invalid value for "parameters", parameters 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?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_CREATE_TVC_DEPLOYMENT'])
+      return false unless type_validator.valid?(@type)
+      return false if @timestamp_ms.nil?
+      return false if @organization_id.nil?
+      return false if @parameters.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_CREATE_TVC_DEPLOYMENT'])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = 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 &&
+          type == o.type &&
+          timestamp_ms == o.timestamp_ms &&
+          organization_id == o.organization_id &&
+          parameters == o.parameters
+    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
+      [type, timestamp_ms, organization_id, parameters].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.openapi_types.each_pair do |key, type|
+        if 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]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        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 :DateTime
+        DateTime.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
+        TurnkeyClient.const_get(type).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.openapi_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