Class JobListParams
-
- All Implemented Interfaces:
-
com.hiddenlayer.api.core.Params
public final class JobListParams implements Params
Get scan results (Summaries)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classJobListParams.BuilderA builder for JobListParams.
public final classJobListParams.ComplianceStatuspublic final classJobListParams.ModelNamefilter by the model name
public final classJobListParams.RequestSourceIdentifies the system that requested the scan
public final classJobListParams.SeveritySeverities
public final classJobListParams.Sourcesource of model related to scans
-
Method Summary
Modifier and Type Method Description final Optional<List<JobListParams.ComplianceStatus>>complianceStatus()A comma separated list of rule set evaluation statuses to include final Optional<String>detectionCategory()filter by a single detection category final Optional<OffsetDateTime>endTime()End Time final Optional<Boolean>latestPerModelVersionOnly()only return latest result per model version final Optional<Long>limit()final Optional<List<String>>modelIds()Model ID final Optional<JobListParams.ModelName>modelName()filter by the model name final Optional<List<String>>modelVersionIds()Model Version IDs final Optional<Long>offset()final Optional<List<JobListParams.RequestSource>>requestSource()Filter by request source using a comma-separated list final Optional<String>scannerVersion()filter by version of the scanner final Optional<JobListParams.Severity>severity()Severities final Optional<String>sort()allow sorting by model name, status, severity or created at, ascending (+) or the default descending (-) final Optional<JobListParams.Source>source()source of model related to scans final Optional<OffsetDateTime>startTime()Start Time final Optional<List<String>>status()Statuses final Optional<String>xCorrelationId()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final JobListParams.BuildertoBuilder()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static JobListParamsnone()final static JobListParams.Builderbuilder()Returns a mutable builder for constructing an instance of JobListParams. -
-
Method Detail
-
complianceStatus
final Optional<List<JobListParams.ComplianceStatus>> complianceStatus()
A comma separated list of rule set evaluation statuses to include
-
detectionCategory
final Optional<String> detectionCategory()
filter by a single detection category
-
endTime
final Optional<OffsetDateTime> endTime()
End Time
-
latestPerModelVersionOnly
final Optional<Boolean> latestPerModelVersionOnly()
only return latest result per model version
-
modelName
final Optional<JobListParams.ModelName> modelName()
filter by the model name
-
modelVersionIds
final Optional<List<String>> modelVersionIds()
Model Version IDs
-
requestSource
final Optional<List<JobListParams.RequestSource>> requestSource()
Filter by request source using a comma-separated list
-
scannerVersion
final Optional<String> scannerVersion()
filter by version of the scanner
-
severity
final Optional<JobListParams.Severity> severity()
Severities
-
sort
final Optional<String> sort()
allow sorting by model name, status, severity or created at, ascending (+) or the default descending (-)
-
source
final Optional<JobListParams.Source> source()
source of model related to scans
-
startTime
final Optional<OffsetDateTime> startTime()
Start Time
-
xCorrelationId
final Optional<String> xCorrelationId()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final JobListParams.Builder toBuilder()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static JobListParams none()
-
builder
final static JobListParams.Builder builder()
Returns a mutable builder for constructing an instance of JobListParams.
-
-
-
-