volcano-sdk 0.32.7 → 0.34.0

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

@@ -0,0 +1,372 @@
+=begin
+#Volcano API
+
+#Public API for Volcano 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
+  # One operation on an execution's timeline.
+  class DurableExecutionOperation < ApiModelBase
+    # Identifies the operation within its execution.
+    attr_accessor :id
+
+    # The operation this one ran inside: a child context, map item or parallel branch, or the execution itself for top-level work. Absent only on the execution. 
+    attr_accessor :parent_id
+
+    # The name the handler gave the operation. Map items and parallel branches the handler did not name carry the SDK's positional name, such as `map-item-0`. Absent for an unnamed operation. 
+    attr_accessor :name
+
+    # The kind of checkpointed operation Volcano recorded.
+    attr_accessor :type
+
+    # The operation as the handler wrote it: `ctx.step` is `step`, `ctx.wait` is `wait`, `ctx.waitUntil` is `wait_until`, `ctx.child` is `child`, `ctx.map` is `map` with one `map_item` per item, and `ctx.parallel` is `parallel` with one `parallel_branch` per branch. 
+    attr_accessor :kind
+
+    # Where the operation stands. `waiting` holds no runtime: a wait that has not elapsed, or a `waitUntil` between checks. `retrying` is a step whose last attempt failed and whose next one is scheduled at `next_attempt_at`. Work still open when the execution ended is `cancelled` at the moment it ended. `unknown` is only ever the execution itself, when its outcome was lost with its history, as in the execution's own `unknown` status. 
+    attr_accessor :status
+
+    attr_accessor :started_at
+
+    # Present once the operation has ended.
+    attr_accessor :ended_at
+
+    # When a wait is due to elapse.
+    attr_accessor :scheduled_end_at
+
+    # When a step's next attempt, or a `waitUntil`'s next check, is due. Present only while one is scheduled. 
+    attr_accessor :next_attempt_at
+
+    # Each run of a step's body, in order. Present on steps and `waitUntil` polls, where each check is an attempt. 
+    attr_accessor :attempts
+
+    attr_accessor :error
+
+    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',
+        :'parent_id' => :'parent_id',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'kind' => :'kind',
+        :'status' => :'status',
+        :'started_at' => :'started_at',
+        :'ended_at' => :'ended_at',
+        :'scheduled_end_at' => :'scheduled_end_at',
+        :'next_attempt_at' => :'next_attempt_at',
+        :'attempts' => :'attempts',
+        :'error' => :'error'
+      }
+    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',
+        :'parent_id' => :'String',
+        :'name' => :'String',
+        :'type' => :'String',
+        :'kind' => :'String',
+        :'status' => :'String',
+        :'started_at' => :'Time',
+        :'ended_at' => :'Time',
+        :'scheduled_end_at' => :'Time',
+        :'next_attempt_at' => :'Time',
+        :'attempts' => :'Array<DurableExecutionOperationAttempt>',
+        :'error' => :'DurableExecutionError'
+      }
+    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::DurableExecutionOperation` 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::DurableExecutionOperation`. 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?(:'parent_id')
+        self.parent_id = attributes[:'parent_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      else
+        self.kind = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      else
+        self.started_at = nil
+      end
+
+      if attributes.key?(:'ended_at')
+        self.ended_at = attributes[:'ended_at']
+      end
+
+      if attributes.key?(:'scheduled_end_at')
+        self.scheduled_end_at = attributes[:'scheduled_end_at']
+      end
+
+      if attributes.key?(:'next_attempt_at')
+        self.next_attempt_at = attributes[:'next_attempt_at']
+      end
+
+      if attributes.key?(:'attempts')
+        if (value = attributes[:'attempts']).is_a?(Array)
+          self.attempts = value
+        end
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @started_at.nil?
+        invalid_properties.push('invalid value for "started_at", started_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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["execution", "step", "wait", "callback", "context", "chained_invoke"])
+      return false unless type_validator.valid?(@type)
+      return false if @kind.nil?
+      kind_validator = EnumAttributeValidator.new('String', ["execution", "step", "wait", "wait_until", "callback", "child", "map", "map_item", "parallel", "parallel_branch", "invoke"])
+      return false unless kind_validator.valid?(@kind)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["running", "waiting", "retrying", "succeeded", "failed", "cancelled", "timed_out", "stopped", "unknown"])
+      return false unless status_validator.valid?(@status)
+      return false if @started_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 checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["execution", "step", "wait", "callback", "context", "chained_invoke"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["execution", "step", "wait", "wait_until", "callback", "child", "map", "map_item", "parallel", "parallel_branch", "invoke"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
+      end
+      @kind = kind
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["running", "waiting", "retrying", "succeeded", "failed", "cancelled", "timed_out", "stopped", "unknown"])
+      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] started_at Value to be assigned
+    def started_at=(started_at)
+      if started_at.nil?
+        fail ArgumentError, 'started_at cannot be nil'
+      end
+
+      @started_at = started_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 &&
+          parent_id == o.parent_id &&
+          name == o.name &&
+          type == o.type &&
+          kind == o.kind &&
+          status == o.status &&
+          started_at == o.started_at &&
+          ended_at == o.ended_at &&
+          scheduled_end_at == o.scheduled_end_at &&
+          next_attempt_at == o.next_attempt_at &&
+          attempts == o.attempts &&
+          error == o.error
+    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, parent_id, name, type, kind, status, started_at, ended_at, scheduled_end_at, next_attempt_at, attempts, error].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/durable_execution_operation_attempt.rb

@@ -0,0 +1,271 @@
+=begin
+#Volcano API
+
+#Public API for Volcano 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
+  # One run of a step's body.
+  class DurableExecutionOperationAttempt < ApiModelBase
+    # The attempt's number, starting at 1.
+    attr_accessor :attempt
+
+    # How the attempt ended. A `waitUntil` check whose condition did not hold yet is `succeeded`: the check ran, and the poll continues. 
+    attr_accessor :status
+
+    attr_accessor :started_at
+
+    # Present once the attempt has ended.
+    attr_accessor :ended_at
+
+    attr_accessor :error
+
+    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
+      {
+        :'attempt' => :'attempt',
+        :'status' => :'status',
+        :'started_at' => :'started_at',
+        :'ended_at' => :'ended_at',
+        :'error' => :'error'
+      }
+    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
+      {
+        :'attempt' => :'Integer',
+        :'status' => :'String',
+        :'started_at' => :'Time',
+        :'ended_at' => :'Time',
+        :'error' => :'DurableExecutionError'
+      }
+    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::DurableExecutionOperationAttempt` 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::DurableExecutionOperationAttempt`. 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?(:'attempt')
+        self.attempt = attributes[:'attempt']
+      else
+        self.attempt = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      else
+        self.started_at = nil
+      end
+
+      if attributes.key?(:'ended_at')
+        self.ended_at = attributes[:'ended_at']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      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 @attempt.nil?
+        invalid_properties.push('invalid value for "attempt", attempt cannot be nil.')
+      end
+
+      if @attempt < 1
+        invalid_properties.push('invalid value for "attempt", must be greater than or equal to 1.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @started_at.nil?
+        invalid_properties.push('invalid value for "started_at", started_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 @attempt.nil?
+      return false if @attempt < 1
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["running", "succeeded", "failed"])
+      return false unless status_validator.valid?(@status)
+      return false if @started_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attempt Value to be assigned
+    def attempt=(attempt)
+      if attempt.nil?
+        fail ArgumentError, 'attempt cannot be nil'
+      end
+
+      if attempt < 1
+        fail ArgumentError, 'invalid value for "attempt", must be greater than or equal to 1.'
+      end
+
+      @attempt = attempt
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["running", "succeeded", "failed"])
+      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] started_at Value to be assigned
+    def started_at=(started_at)
+      if started_at.nil?
+        fail ArgumentError, 'started_at cannot be nil'
+      end
+
+      @started_at = started_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 &&
+          attempt == o.attempt &&
+          status == o.status &&
+          started_at == o.started_at &&
+          ended_at == o.ended_at &&
+          error == o.error
+    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
+      [attempt, status, started_at, ended_at, error].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