lib/dependency-tracker-client/api/bom_api.rb
# Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
# This endpoint is intended to be used in conjunction with uploading a supported BOM document. Upon upload, a token will be returned. The token can then be queried using this endpoint to determine if any tasks (such as vulnerability analysis) is being performed on the BOM. A value of true indicates processing is occurring. A value of false indicates that no processing is occurring for the specified token. However, a value of false also does not confirm the token is valid, only that no processing is associated with the specified token.
# @param uuid [String] The UUID of the token to query
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
This endpoint is intended to be used in conjunction with uploading a supported BOM document. Upon upload, a token will be returned. The token can then be queried using this endpoint to determine if any tasks (such as vulnerability analysis) is being performed on the BOM. A value of true indicates processing is occurring. A value of false indicates that no processing is occurring for the specified token. However, a value of false also does not confirm the token is valid, only that no processing is associated with the specified token.
Determines if there are any tasks associated with the token that are being processed or in the queue to be processed . This endpoint is intended to be used in conjunction with uploading a supported BOM document . Upon upload a token will be returned . The token can then be queried using this endpoint to determine if any tasks ( such as vulnerability analysis ) is being performed on the BOM . A value of true indicates processing is occurring . A value of false indicates that no processing is occurring for the specified token . However a value of false also does not confirm the token is valid only that no processing is associated with the specified token .
def is_token_being_processed_with_http_info(uuid, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: BomApi.is_token_being_processed ...'
      end
      if @api_client.config.client_side_validation && uuid.nil?
        fail ArgumentError, "Missing the required parameter 'uuid' when calling BomApi.is_token_being_processed"
      end
      local_var_path = '/v1/bom/token/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      form_params = opts[:form_params] || {}
      post_body = opts[:body] 
      return_type = opts[:return_type] 
      auth_names = opts[:auth_names] || ['X-Api-Key']
      new_options = opts.merge(
        :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: BomApi#is_token_being_processed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def is_token_being_processed_with_http_info ( uuid , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: BomApi.is_token_being_processed ...' end if @api_client . config . client_side_validation && uuid . nil? fail ArgumentError , "Missing the required parameter 'uuid' when calling BomApi.is_token_being_processed" end local_var_path = '/v1/bom/token/{uuid}' . sub ( '{' + 'uuid' + '}' , CGI . escape ( uuid . to_s ) ) query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } form_params = opts [ :form_params ] || { } post_body = opts [ :body ] return_type = opts [ :return_type ] auth_names = opts [ :auth_names ] || [ 'X-Api-Key' ] new_options = opts . merge ( :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: BomApi#is_token_being_processed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
Determines if there are any tasks associated with the token that are being processed or in the queue to be processed .
# verify the required parameter 'uuid' is set # resource path # query parameters # header parameters # form parameters # http body (model) # return_type # auth_names
nil, response status code and response headers
nil response status code and response headers
Array<(nil, Integer, Hash)>
uuid
The UUID of the token to query
The UUID of the token to query
opts
<not_specific>
<not_specific>
opts the optional parameters
opts the optional parameters