LibraryUsage

class oci.jms.models.LibraryUsage(**kwargs)

Bases: object

Library usage during a specified time period.

Attributes:

CONFIDENCE_LEVEL_HIGH

A constant which can be used with the confidence_level property of a LibraryUsage.

CONFIDENCE_LEVEL_LOW

A constant which can be used with the confidence_level property of a LibraryUsage.

CONFIDENCE_LEVEL_MEDIUM

A constant which can be used with the confidence_level property of a LibraryUsage.

approximate_application_count

Gets the approximate_application_count of this LibraryUsage.

approximate_deployed_application_count

Gets the approximate_deployed_application_count of this LibraryUsage.

approximate_java_server_instance_count

Gets the approximate_java_server_instance_count of this LibraryUsage.

approximate_managed_instance_count

Gets the approximate_managed_instance_count of this LibraryUsage.

confidence_level

Gets the confidence_level of this LibraryUsage.

cve_id

Gets the cve_id of this LibraryUsage.

cvss_score

Gets the cvss_score of this LibraryUsage.

fleet_id

[Required] Gets the fleet_id of this LibraryUsage.

highest_vulnerability_score

Gets the highest_vulnerability_score of this LibraryUsage.

is_dynamically_detected

[Required] Gets the is_dynamically_detected of this LibraryUsage.

library_key

[Required] Gets the library_key of this LibraryUsage.

library_name

[Required] Gets the library_name of this LibraryUsage.

library_version

Gets the library_version of this LibraryUsage.

time_end

Gets the time_end of this LibraryUsage.

time_first_seen

Gets the time_first_seen of this LibraryUsage.

time_last_cve_refreshed

Gets the time_last_cve_refreshed of this LibraryUsage.

time_last_seen

Gets the time_last_seen of this LibraryUsage.

time_start

Gets the time_start of this LibraryUsage.

vulnerabilities

Gets the vulnerabilities of this LibraryUsage.

Methods:

__init__(**kwargs)

Initializes a new LibraryUsage object with values from keyword arguments.

CONFIDENCE_LEVEL_HIGH = 'HIGH'

A constant which can be used with the confidence_level property of a LibraryUsage. This constant has a value of “HIGH”

CONFIDENCE_LEVEL_LOW = 'LOW'

A constant which can be used with the confidence_level property of a LibraryUsage. This constant has a value of “LOW”

CONFIDENCE_LEVEL_MEDIUM = 'MEDIUM'

A constant which can be used with the confidence_level property of a LibraryUsage. This constant has a value of “MEDIUM”

__init__(**kwargs)

Initializes a new LibraryUsage object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • library_key (str) – The value to assign to the library_key property of this LibraryUsage.

  • fleet_id (str) – The value to assign to the fleet_id property of this LibraryUsage.

  • library_name (str) – The value to assign to the library_name property of this LibraryUsage.

  • library_version (str) – The value to assign to the library_version property of this LibraryUsage.

  • cve_id (str) – The value to assign to the cve_id property of this LibraryUsage.

  • cvss_score (float) – The value to assign to the cvss_score property of this LibraryUsage.

  • is_dynamically_detected (bool) – The value to assign to the is_dynamically_detected property of this LibraryUsage.

  • highest_vulnerability_score (float) – The value to assign to the highest_vulnerability_score property of this LibraryUsage.

  • vulnerabilities (list[oci.jms.models.LibraryVulnerability]) – The value to assign to the vulnerabilities property of this LibraryUsage.

  • confidence_level (str) – The value to assign to the confidence_level property of this LibraryUsage. Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • approximate_application_count (int) – The value to assign to the approximate_application_count property of this LibraryUsage.

  • approximate_java_server_instance_count (int) – The value to assign to the approximate_java_server_instance_count property of this LibraryUsage.

  • approximate_deployed_application_count (int) – The value to assign to the approximate_deployed_application_count property of this LibraryUsage.

  • approximate_managed_instance_count (int) – The value to assign to the approximate_managed_instance_count property of this LibraryUsage.

  • time_start (datetime) – The value to assign to the time_start property of this LibraryUsage.

  • time_end (datetime) – The value to assign to the time_end property of this LibraryUsage.

  • time_first_seen (datetime) – The value to assign to the time_first_seen property of this LibraryUsage.

  • time_last_seen (datetime) – The value to assign to the time_last_seen property of this LibraryUsage.

  • time_last_cve_refreshed (datetime) – The value to assign to the time_last_cve_refreshed property of this LibraryUsage.

property approximate_application_count

Gets the approximate_application_count of this LibraryUsage. The approximate count of applications using the library.

Returns

The approximate_application_count of this LibraryUsage.

Return type

int

property approximate_deployed_application_count

Gets the approximate_deployed_application_count of this LibraryUsage. The approximate count of deployed applications using the library.

Returns

The approximate_deployed_application_count of this LibraryUsage.

Return type

int

property approximate_java_server_instance_count

Gets the approximate_java_server_instance_count of this LibraryUsage. The approximate count of Java Server instances using the library.

Returns

The approximate_java_server_instance_count of this LibraryUsage.

Return type

int

property approximate_managed_instance_count

Gets the approximate_managed_instance_count of this LibraryUsage. The approximate count of managed instances using the library.

Returns

The approximate_managed_instance_count of this LibraryUsage.

Return type

int

property confidence_level

Gets the confidence_level of this LibraryUsage. Confidence level of the assessed library’s vulnerabilities.

Allowed values for this property are: “HIGH”, “MEDIUM”, “LOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The confidence_level of this LibraryUsage.

Return type

str

property cve_id

Gets the cve_id of this LibraryUsage. Deprecated, use vulnerabilities instead. The Common Vulnerabilities and Exposures (CVE) ID.

Returns

The cve_id of this LibraryUsage.

Return type

str

property cvss_score

Gets the cvss_score of this LibraryUsage. Deprecated, use highestVulnerabilityScore instead. The Common Vulnerability Scoring System (CVSS) score. If cvssScore is not available, it will be set to -1.0. It is set to 0.0 when cveId is null.

Returns

The cvss_score of this LibraryUsage.

Return type

float

property fleet_id

[Required] Gets the fleet_id of this LibraryUsage. The OCID of the related fleet.

Returns

The fleet_id of this LibraryUsage.

Return type

str

property highest_vulnerability_score

Gets the highest_vulnerability_score of this LibraryUsage. Highest CVSS score among the all vulnerabilities. If highest CVSS score is not available, it will be set to -1.0. It is set to 0.0 when there is no associated vulnerabilities.

Returns

The highest_vulnerability_score of this LibraryUsage.

Return type

float

property is_dynamically_detected

[Required] Gets the is_dynamically_detected of this LibraryUsage. Indicates whether the library was dynamically detected.

Returns

The is_dynamically_detected of this LibraryUsage.

Return type

bool

property library_key

[Required] Gets the library_key of this LibraryUsage. The internal identifier of the library.

Returns

The library_key of this LibraryUsage.

Return type

str

property library_name

[Required] Gets the library_name of this LibraryUsage. The name of the library.

Returns

The library_name of this LibraryUsage.

Return type

str

property library_version

Gets the library_version of this LibraryUsage. The version of the library.

Returns

The library_version of this LibraryUsage.

Return type

str

property time_end

Gets the time_end of this LibraryUsage. Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.

Returns

The time_end of this LibraryUsage.

Return type

datetime

property time_first_seen

Gets the time_first_seen of this LibraryUsage. The date and time the resource was _first_ reported to JMS. This is potentially _before_ the specified time period provided by the filters. For example, a resource can be first reported to JMS before the start of a specified time period, if it is also reported during the time period.

Returns

The time_first_seen of this LibraryUsage.

Return type

datetime

property time_last_cve_refreshed

Gets the time_last_cve_refreshed of this LibraryUsage. Deprecated. The date and time of the last CVEs refresh was completed.

Returns

The time_last_cve_refreshed of this LibraryUsage.

Return type

datetime

property time_last_seen

Gets the time_last_seen of this LibraryUsage. The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.

Returns

The time_last_seen of this LibraryUsage.

Return type

datetime

property time_start

Gets the time_start of this LibraryUsage. Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.

Returns

The time_start of this LibraryUsage.

Return type

datetime

property vulnerabilities

Gets the vulnerabilities of this LibraryUsage. The list of library vulnerabilities.

Returns

The vulnerabilities of this LibraryUsage.

Return type

list[oci.jms.models.LibraryVulnerability]