R/source_detailed_metrics_out.R

In namsor/namsor-r-sdk2: R Package Client for NamSor API v2

# NamSor API v2
#
# NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! 
#
# The version of the OpenAPI document: 2.0.10
# Contact: contact@namsor.com
# Generated by: https://openapi-generator.tech

#' @docType class
#' @title SourceDetailedMetricsOut
#' @description SourceDetailedMetricsOut Class
#' @format An \code{R6Class} generator object
#' @field classifierName  character [optional]
#'
#' @field source  \link{APIKeyOut} [optional]
#'
#' @field aiEstimateTotal  integer [optional]
#'
#' @field aiEstimatePrecision  numeric [optional]
#'
#' @field aiEstimateRecall  numeric [optional]
#'
#' @field metricTimeStamp  integer [optional]
#'
#' @field aiStartTime  integer [optional]
#'
#' @field aiLearnTotal  integer [optional]
#'
#' @field snapshotDate  integer [optional]
#'
#' @field expectedClassMetrics  list( \link{ExpectedClassMetricsOut} ) [optional]
#'
#'
#' @importFrom R6 R6Class
#' @importFrom jsonlite fromJSON toJSON
#' @export
SourceDetailedMetricsOut <- R6::R6Class(
  'SourceDetailedMetricsOut',
  public = list(
    `classifierName` = NULL,
    `source` = NULL,
    `aiEstimateTotal` = NULL,
    `aiEstimatePrecision` = NULL,
    `aiEstimateRecall` = NULL,
    `metricTimeStamp` = NULL,
    `aiStartTime` = NULL,
    `aiLearnTotal` = NULL,
    `snapshotDate` = NULL,
    `expectedClassMetrics` = NULL,
    initialize = function(`classifierName`=NULL, `source`=NULL, `aiEstimateTotal`=NULL, `aiEstimatePrecision`=NULL, `aiEstimateRecall`=NULL, `metricTimeStamp`=NULL, `aiStartTime`=NULL, `aiLearnTotal`=NULL, `snapshotDate`=NULL, `expectedClassMetrics`=NULL, ...){
      local.optional.var <- list(...)
      if (!is.null(`classifierName`)) {
        stopifnot(is.character(`classifierName`), length(`classifierName`) == 1)
        self$`classifierName` <- `classifierName`
      }
      if (!is.null(`source`)) {
        stopifnot(R6::is.R6(`source`))
        self$`source` <- `source`
      }
      if (!is.null(`aiEstimateTotal`)) {
        stopifnot(is.numeric(`aiEstimateTotal`), length(`aiEstimateTotal`) == 1)
        self$`aiEstimateTotal` <- `aiEstimateTotal`
      }
      if (!is.null(`aiEstimatePrecision`)) {
        stopifnot(is.numeric(`aiEstimatePrecision`), length(`aiEstimatePrecision`) == 1)
        self$`aiEstimatePrecision` <- `aiEstimatePrecision`
      }
      if (!is.null(`aiEstimateRecall`)) {
        stopifnot(is.numeric(`aiEstimateRecall`), length(`aiEstimateRecall`) == 1)
        self$`aiEstimateRecall` <- `aiEstimateRecall`
      }
      if (!is.null(`metricTimeStamp`)) {
        stopifnot(is.numeric(`metricTimeStamp`), length(`metricTimeStamp`) == 1)
        self$`metricTimeStamp` <- `metricTimeStamp`
      }
      if (!is.null(`aiStartTime`)) {
        stopifnot(is.numeric(`aiStartTime`), length(`aiStartTime`) == 1)
        self$`aiStartTime` <- `aiStartTime`
      }
      if (!is.null(`aiLearnTotal`)) {
        stopifnot(is.numeric(`aiLearnTotal`), length(`aiLearnTotal`) == 1)
        self$`aiLearnTotal` <- `aiLearnTotal`
      }
      if (!is.null(`snapshotDate`)) {
        stopifnot(is.numeric(`snapshotDate`), length(`snapshotDate`) == 1)
        self$`snapshotDate` <- `snapshotDate`
      }
      if (!is.null(`expectedClassMetrics`)) {
        stopifnot(is.vector(`expectedClassMetrics`), length(`expectedClassMetrics`) != 0)
        sapply(`expectedClassMetrics`, function(x) stopifnot(R6::is.R6(x)))
        self$`expectedClassMetrics` <- `expectedClassMetrics`
      }
    },
    toJSON = function() {
      SourceDetailedMetricsOutObject <- list()
      if (!is.null(self$`classifierName`)) {
        SourceDetailedMetricsOutObject[['classifierName']] <-
          self$`classifierName`
      }
      if (!is.null(self$`source`)) {
        SourceDetailedMetricsOutObject[['source']] <-
          self$`source`$toJSON()
      }
      if (!is.null(self$`aiEstimateTotal`)) {
        SourceDetailedMetricsOutObject[['aiEstimateTotal']] <-
          self$`aiEstimateTotal`
      }
      if (!is.null(self$`aiEstimatePrecision`)) {
        SourceDetailedMetricsOutObject[['aiEstimatePrecision']] <-
          self$`aiEstimatePrecision`
      }
      if (!is.null(self$`aiEstimateRecall`)) {
        SourceDetailedMetricsOutObject[['aiEstimateRecall']] <-
          self$`aiEstimateRecall`
      }
      if (!is.null(self$`metricTimeStamp`)) {
        SourceDetailedMetricsOutObject[['metricTimeStamp']] <-
          self$`metricTimeStamp`
      }
      if (!is.null(self$`aiStartTime`)) {
        SourceDetailedMetricsOutObject[['aiStartTime']] <-
          self$`aiStartTime`
      }
      if (!is.null(self$`aiLearnTotal`)) {
        SourceDetailedMetricsOutObject[['aiLearnTotal']] <-
          self$`aiLearnTotal`
      }
      if (!is.null(self$`snapshotDate`)) {
        SourceDetailedMetricsOutObject[['snapshotDate']] <-
          self$`snapshotDate`
      }
      if (!is.null(self$`expectedClassMetrics`)) {
        SourceDetailedMetricsOutObject[['expectedClassMetrics']] <-
          lapply(self$`expectedClassMetrics`, function(x) x$toJSON())
      }

      SourceDetailedMetricsOutObject
    },
    fromJSON = function(SourceDetailedMetricsOutJson) {
      SourceDetailedMetricsOutObject <- jsonlite::fromJSON(SourceDetailedMetricsOutJson)
      if (!is.null(SourceDetailedMetricsOutObject$`classifierName`)) {
        self$`classifierName` <- SourceDetailedMetricsOutObject$`classifierName`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`source`)) {
        sourceObject <- APIKeyOut$new()
        sourceObject$fromJSON(jsonlite::toJSON(SourceDetailedMetricsOutObject$source, auto_unbox = TRUE, digits = NA))
        self$`source` <- sourceObject
      }
      if (!is.null(SourceDetailedMetricsOutObject$`aiEstimateTotal`)) {
        self$`aiEstimateTotal` <- SourceDetailedMetricsOutObject$`aiEstimateTotal`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`aiEstimatePrecision`)) {
        self$`aiEstimatePrecision` <- SourceDetailedMetricsOutObject$`aiEstimatePrecision`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`aiEstimateRecall`)) {
        self$`aiEstimateRecall` <- SourceDetailedMetricsOutObject$`aiEstimateRecall`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`metricTimeStamp`)) {
        self$`metricTimeStamp` <- SourceDetailedMetricsOutObject$`metricTimeStamp`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`aiStartTime`)) {
        self$`aiStartTime` <- SourceDetailedMetricsOutObject$`aiStartTime`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`aiLearnTotal`)) {
        self$`aiLearnTotal` <- SourceDetailedMetricsOutObject$`aiLearnTotal`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`snapshotDate`)) {
        self$`snapshotDate` <- SourceDetailedMetricsOutObject$`snapshotDate`
      }
      if (!is.null(SourceDetailedMetricsOutObject$`expectedClassMetrics`)) {
        self$`expectedClassMetrics` <- ApiClient$new()$deserializeObj(SourceDetailedMetricsOutObject$`expectedClassMetrics`, "array[ExpectedClassMetricsOut]", loadNamespace("namsor"))
      }
    },
    toJSONString = function() {
      jsoncontent <- c(
        if (!is.null(self$`classifierName`)) {
        sprintf(
        '"classifierName":
          "%s"
                ',
        self$`classifierName`
        )},
        if (!is.null(self$`source`)) {
        sprintf(
        '"source":
        %s
        ',
        jsonlite::toJSON(self$`source`$toJSON(), auto_unbox=TRUE, digits = NA)
        )},
        if (!is.null(self$`aiEstimateTotal`)) {
        sprintf(
        '"aiEstimateTotal":
          %d
                ',
        self$`aiEstimateTotal`
        )},
        if (!is.null(self$`aiEstimatePrecision`)) {
        sprintf(
        '"aiEstimatePrecision":
          %d
                ',
        self$`aiEstimatePrecision`
        )},
        if (!is.null(self$`aiEstimateRecall`)) {
        sprintf(
        '"aiEstimateRecall":
          %d
                ',
        self$`aiEstimateRecall`
        )},
        if (!is.null(self$`metricTimeStamp`)) {
        sprintf(
        '"metricTimeStamp":
          %d
                ',
        self$`metricTimeStamp`
        )},
        if (!is.null(self$`aiStartTime`)) {
        sprintf(
        '"aiStartTime":
          %d
                ',
        self$`aiStartTime`
        )},
        if (!is.null(self$`aiLearnTotal`)) {
        sprintf(
        '"aiLearnTotal":
          %d
                ',
        self$`aiLearnTotal`
        )},
        if (!is.null(self$`snapshotDate`)) {
        sprintf(
        '"snapshotDate":
          %d
                ',
        self$`snapshotDate`
        )},
        if (!is.null(self$`expectedClassMetrics`)) {
        sprintf(
        '"expectedClassMetrics":
        [%s]
',
        paste(sapply(self$`expectedClassMetrics`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",")
        )}
      )
      jsoncontent <- paste(jsoncontent, collapse = ",")
      paste('{', jsoncontent, '}', sep = "")
    },
    fromJSONString = function(SourceDetailedMetricsOutJson) {
      SourceDetailedMetricsOutObject <- jsonlite::fromJSON(SourceDetailedMetricsOutJson)
      self$`classifierName` <- SourceDetailedMetricsOutObject$`classifierName`
      self$`source` <- APIKeyOut$new()$fromJSON(jsonlite::toJSON(SourceDetailedMetricsOutObject$source, auto_unbox = TRUE, digits = NA))
      self$`aiEstimateTotal` <- SourceDetailedMetricsOutObject$`aiEstimateTotal`
      self$`aiEstimatePrecision` <- SourceDetailedMetricsOutObject$`aiEstimatePrecision`
      self$`aiEstimateRecall` <- SourceDetailedMetricsOutObject$`aiEstimateRecall`
      self$`metricTimeStamp` <- SourceDetailedMetricsOutObject$`metricTimeStamp`
      self$`aiStartTime` <- SourceDetailedMetricsOutObject$`aiStartTime`
      self$`aiLearnTotal` <- SourceDetailedMetricsOutObject$`aiLearnTotal`
      self$`snapshotDate` <- SourceDetailedMetricsOutObject$`snapshotDate`
      self$`expectedClassMetrics` <- ApiClient$new()$deserializeObj(SourceDetailedMetricsOutObject$`expectedClassMetrics`, "array[ExpectedClassMetricsOut]", loadNamespace("namsor"))
      self
    }
  )
)