volcano-sdk 0.5.2

data/lib/volcano/generated/lib/volcano-generated/api/variables_api.rb

@@ -0,0 +1,454 @@
+=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 'cgi'
+
+module Volcano::Generated
+  class VariablesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create or update a variable
+    # Creates a project-level environment variable and triggers asynchronous propagation to deployed functions and frontends in the project's configured regions. 
+    # @param id [String] Project ID
+    # @param create_variable_request [CreateVariableRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Variable]
+    def create_variable(id, create_variable_request, opts = {})
+      data, _status_code, _headers = create_variable_with_http_info(id, create_variable_request, opts)
+      data
+    end
+
+    # Create or update a variable
+    # Creates a project-level environment variable and triggers asynchronous propagation to deployed functions and frontends in the project's configured regions. 
+    # @param id [String] Project ID
+    # @param create_variable_request [CreateVariableRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Variable, Integer, Hash)>] Variable data, response status code and response headers
+    def create_variable_with_http_info(id, create_variable_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VariablesApi.create_variable ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling VariablesApi.create_variable"
+      end
+      # verify the required parameter 'create_variable_request' is set
+      if @api_client.config.client_side_validation && create_variable_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_variable_request' when calling VariablesApi.create_variable"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/variables'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_variable_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Variable'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"VariablesApi.create_variable",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VariablesApi#create_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a variable
+    # Deletes a project-level environment variable and triggers asynchronous propagation of the removal to deployed functions and frontends in the project's configured regions. 
+    # @param id [String] Project ID
+    # @param name [String] Variable name
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_variable(id, name, opts = {})
+      delete_variable_with_http_info(id, name, opts)
+      nil
+    end
+
+    # Delete a variable
+    # Deletes a project-level environment variable and triggers asynchronous propagation of the removal to deployed functions and frontends in the project&#39;s configured regions. 
+    # @param id [String] Project ID
+    # @param name [String] Variable name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_variable_with_http_info(id, name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VariablesApi.delete_variable ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling VariablesApi.delete_variable"
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling VariablesApi.delete_variable"
+      end
+      if @api_client.config.client_side_validation && name.to_s.length > 256
+        fail ArgumentError, 'invalid value for "name" when calling VariablesApi.delete_variable, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name" when calling VariablesApi.delete_variable, the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+      if @api_client.config.client_side_validation && name !~ pattern
+        fail ArgumentError, "invalid value for 'name' when calling VariablesApi.delete_variable, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/projects/{id}/variables/{name}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"VariablesApi.delete_variable",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VariablesApi#delete_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get variable by name
+    # Returns a project-level environment variable used by deployed functions and frontends. 
+    # @param id [String] Project ID
+    # @param name [String] Variable name
+    # @param [Hash] opts the optional parameters
+    # @return [Variable]
+    def get_variable(id, name, opts = {})
+      data, _status_code, _headers = get_variable_with_http_info(id, name, opts)
+      data
+    end
+
+    # Get variable by name
+    # Returns a project-level environment variable used by deployed functions and frontends. 
+    # @param id [String] Project ID
+    # @param name [String] Variable name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Variable, Integer, Hash)>] Variable data, response status code and response headers
+    def get_variable_with_http_info(id, name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VariablesApi.get_variable ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling VariablesApi.get_variable"
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling VariablesApi.get_variable"
+      end
+      if @api_client.config.client_side_validation && name.to_s.length > 256
+        fail ArgumentError, 'invalid value for "name" when calling VariablesApi.get_variable, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name" when calling VariablesApi.get_variable, the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+      if @api_client.config.client_side_validation && name !~ pattern
+        fail ArgumentError, "invalid value for 'name' when calling VariablesApi.get_variable, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/projects/{id}/variables/{name}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Variable'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"VariablesApi.get_variable",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VariablesApi#get_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all variables for a project
+    # Returns project-level environment variables used by deployed functions and frontends. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-indexed) for offset pagination. Declares no schema default so the request validator does not inject one: handlers that omit &#x60;page&#x60; see it unset (nil) and default to 1 in code, while cursor-first endpoints (e.g. the project deployments feed) can detect its absence to stay in keyset/search mode. Supplying &#x60;page&#x60; selects offset pagination. 
+    # @option opts [Integer] :limit Number of items per page (max 100) (default to 10)
+    # @option opts [String] :cursor Opaque keyset pagination cursor from a previous response&#39;s &#x60;next_cursor&#x60; — pages forward. Mutually exclusive with &#x60;page&#x60; and &#x60;ending_before&#x60;; combining them returns 400. When supplied, the request&#39;s &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [String] :ending_before Opaque keyset pagination cursor from a previous response&#39;s &#x60;prev_cursor&#x60; — pages backward (the page immediately preceding this cursor). Mutually exclusive with &#x60;page&#x60; and &#x60;cursor&#x60;; combining them returns 400. &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [Integer] :offset Bounded row offset past the keyset anchor named by &#x60;cursor&#x60; (forward) or &#x60;ending_before&#x60; (backward) — the hybrid jump. Seek to the anchor, then skip this many rows within. Used for numbered jump-to-page: from the current page, seek to its next/prev cursor and offset the remaining pages. Only honored on the cursor pagination path; ignored otherwise.  (default to 0)
+    # @option opts [String] :search Case-insensitive substring match on the resource &#x60;name&#x60;. See the endpoint description for supported pagination modes. 
+    # @return [PaginatedVariables]
+    def list_variables(id, opts = {})
+      data, _status_code, _headers = list_variables_with_http_info(id, opts)
+      data
+    end
+
+    # List all variables for a project
+    # Returns project-level environment variables used by deployed functions and frontends. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-indexed) for offset pagination. Declares no schema default so the request validator does not inject one: handlers that omit &#x60;page&#x60; see it unset (nil) and default to 1 in code, while cursor-first endpoints (e.g. the project deployments feed) can detect its absence to stay in keyset/search mode. Supplying &#x60;page&#x60; selects offset pagination. 
+    # @option opts [Integer] :limit Number of items per page (max 100) (default to 10)
+    # @option opts [String] :cursor Opaque keyset pagination cursor from a previous response&#39;s &#x60;next_cursor&#x60; — pages forward. Mutually exclusive with &#x60;page&#x60; and &#x60;ending_before&#x60;; combining them returns 400. When supplied, the request&#39;s &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [String] :ending_before Opaque keyset pagination cursor from a previous response&#39;s &#x60;prev_cursor&#x60; — pages backward (the page immediately preceding this cursor). Mutually exclusive with &#x60;page&#x60; and &#x60;cursor&#x60;; combining them returns 400. &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [Integer] :offset Bounded row offset past the keyset anchor named by &#x60;cursor&#x60; (forward) or &#x60;ending_before&#x60; (backward) — the hybrid jump. Seek to the anchor, then skip this many rows within. Used for numbered jump-to-page: from the current page, seek to its next/prev cursor and offset the remaining pages. Only honored on the cursor pagination path; ignored otherwise.  (default to 0)
+    # @option opts [String] :search Case-insensitive substring match on the resource &#x60;name&#x60;. See the endpoint description for supported pagination modes. 
+    # @return [Array<(PaginatedVariables, Integer, Hash)>] PaginatedVariables data, response status code and response headers
+    def list_variables_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VariablesApi.list_variables ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling VariablesApi.list_variables"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VariablesApi.list_variables, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VariablesApi.list_variables, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling VariablesApi.list_variables, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling VariablesApi.list_variables, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 256
+        fail ArgumentError, 'invalid value for "opts[:"search"]" when calling VariablesApi.list_variables, the character length must be smaller than or equal to 256.'
+      end
+
+      # resource path
+      local_var_path = '/projects/{id}/variables'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedVariables'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"VariablesApi.list_variables",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VariablesApi#list_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a variable
+    # Updates a project-level environment variable and triggers asynchronous propagation to deployed functions and frontends in the project's configured regions. 
+    # @param id [String] Project ID
+    # @param name [String] Variable name
+    # @param update_variable_request [UpdateVariableRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Variable]
+    def update_variable(id, name, update_variable_request, opts = {})
+      data, _status_code, _headers = update_variable_with_http_info(id, name, update_variable_request, opts)
+      data
+    end
+
+    # Update a variable
+    # Updates a project-level environment variable and triggers asynchronous propagation to deployed functions and frontends in the project&#39;s configured regions. 
+    # @param id [String] Project ID
+    # @param name [String] Variable name
+    # @param update_variable_request [UpdateVariableRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Variable, Integer, Hash)>] Variable data, response status code and response headers
+    def update_variable_with_http_info(id, name, update_variable_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: VariablesApi.update_variable ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling VariablesApi.update_variable"
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling VariablesApi.update_variable"
+      end
+      if @api_client.config.client_side_validation && name.to_s.length > 256
+        fail ArgumentError, 'invalid value for "name" when calling VariablesApi.update_variable, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name" when calling VariablesApi.update_variable, the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+      if @api_client.config.client_side_validation && name !~ pattern
+        fail ArgumentError, "invalid value for 'name' when calling VariablesApi.update_variable, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'update_variable_request' is set
+      if @api_client.config.client_side_validation && update_variable_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_variable_request' when calling VariablesApi.update_variable"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/variables/{name}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_variable_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Variable'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"VariablesApi.update_variable",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VariablesApi#update_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end