ProductLicenseSummary¶

class oci.license_manager.models.ProductLicenseSummary(**kwargs)¶

Bases: object

The product license summary.

Attributes

`LICENSE_UNIT_NAMED_USER_PLUS`	A constant which can be used with the license_unit property of a ProductLicenseSummary.
`LICENSE_UNIT_OCPU`	A constant which can be used with the license_unit property of a ProductLicenseSummary.
`LICENSE_UNIT_PROCESSORS`	A constant which can be used with the license_unit property of a ProductLicenseSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ProductLicenseSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ProductLicenseSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ProductLicenseSummary.
`STATUS_INCOMPLETE`	A constant which can be used with the status property of a ProductLicenseSummary.
`STATUS_ISSUES_FOUND`	A constant which can be used with the status property of a ProductLicenseSummary.
`STATUS_OK`	A constant which can be used with the status property of a ProductLicenseSummary.
`STATUS_WARNING`	A constant which can be used with the status property of a ProductLicenseSummary.
`active_license_record_count`	Gets the active_license_record_count of this ProductLicenseSummary.
`compartment_id`	[Required] Gets the compartment_id of this ProductLicenseSummary.
`defined_tags`	Gets the defined_tags of this ProductLicenseSummary.
`display_name`	[Required] Gets the display_name of this ProductLicenseSummary.
`freeform_tags`	Gets the freeform_tags of this ProductLicenseSummary.
`id`	[Required] Gets the id of this ProductLicenseSummary.
`images`	Gets the images of this ProductLicenseSummary.
`is_over_subscribed`	Gets the is_over_subscribed of this ProductLicenseSummary.
`is_unlimited`	Gets the is_unlimited of this ProductLicenseSummary.
`is_vendor_oracle`	[Required] Gets the is_vendor_oracle of this ProductLicenseSummary.
`license_unit`	[Required] Gets the license_unit of this ProductLicenseSummary.
`lifecycle_state`	Gets the lifecycle_state of this ProductLicenseSummary.
`status`	[Required] Gets the status of this ProductLicenseSummary.
`status_description`	Gets the status_description of this ProductLicenseSummary.
`system_tags`	Gets the system_tags of this ProductLicenseSummary.
`time_created`	Gets the time_created of this ProductLicenseSummary.
`time_updated`	Gets the time_updated of this ProductLicenseSummary.
`total_active_license_unit_count`	Gets the total_active_license_unit_count of this ProductLicenseSummary.
`total_license_record_count`	Gets the total_license_record_count of this ProductLicenseSummary.
`total_license_units_consumed`	Gets the total_license_units_consumed of this ProductLicenseSummary.
`vendor_name`	Gets the vendor_name of this ProductLicenseSummary.

Methods

__init__(**kwargs) Initializes a new ProductLicenseSummary object with values from keyword arguments.

LICENSE_UNIT_NAMED_USER_PLUS = 'NAMED_USER_PLUS'¶: A constant which can be used with the license_unit property of a ProductLicenseSummary. This constant has a value of “NAMED_USER_PLUS”

LICENSE_UNIT_OCPU = 'OCPU'¶: A constant which can be used with the license_unit property of a ProductLicenseSummary. This constant has a value of “OCPU”

LICENSE_UNIT_PROCESSORS = 'PROCESSORS'¶: A constant which can be used with the license_unit property of a ProductLicenseSummary. This constant has a value of “PROCESSORS”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ProductLicenseSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ProductLicenseSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ProductLicenseSummary. This constant has a value of “INACTIVE”

STATUS_INCOMPLETE = 'INCOMPLETE'¶: A constant which can be used with the status property of a ProductLicenseSummary. This constant has a value of “INCOMPLETE”

STATUS_ISSUES_FOUND = 'ISSUES_FOUND'¶: A constant which can be used with the status property of a ProductLicenseSummary. This constant has a value of “ISSUES_FOUND”

STATUS_OK = 'OK'¶: A constant which can be used with the status property of a ProductLicenseSummary. This constant has a value of “OK”

STATUS_WARNING = 'WARNING'¶: A constant which can be used with the status property of a ProductLicenseSummary. This constant has a value of “WARNING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this ProductLicenseSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ProductLicenseSummary.
status (str) – The value to assign to the status property of this ProductLicenseSummary. Allowed values for this property are: “INCOMPLETE”, “ISSUES_FOUND”, “WARNING”, “OK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
status_description (str) – The value to assign to the status_description property of this ProductLicenseSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ProductLicenseSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
total_active_license_unit_count (int) – The value to assign to the total_active_license_unit_count property of this ProductLicenseSummary.
total_license_units_consumed (float) – The value to assign to the total_license_units_consumed property of this ProductLicenseSummary.
total_license_record_count (int) – The value to assign to the total_license_record_count property of this ProductLicenseSummary.
active_license_record_count (int) – The value to assign to the active_license_record_count property of this ProductLicenseSummary.
license_unit (str) – The value to assign to the license_unit property of this ProductLicenseSummary. Allowed values for this property are: “OCPU”, “NAMED_USER_PLUS”, “PROCESSORS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_vendor_oracle (bool) – The value to assign to the is_vendor_oracle property of this ProductLicenseSummary.
is_over_subscribed (bool) – The value to assign to the is_over_subscribed property of this ProductLicenseSummary.
is_unlimited (bool) – The value to assign to the is_unlimited property of this ProductLicenseSummary.
display_name (str) – The value to assign to the display_name property of this ProductLicenseSummary.
vendor_name (str) – The value to assign to the vendor_name property of this ProductLicenseSummary.
time_created (datetime) – The value to assign to the time_created property of this ProductLicenseSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ProductLicenseSummary.
images (list[oci.license_manager.models.ImageResponse]) – The value to assign to the images property of this ProductLicenseSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ProductLicenseSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ProductLicenseSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ProductLicenseSummary.

active_license_record_count¶

Gets the active_license_record_count of this ProductLicenseSummary. The number of active license records associated with the product license.

Returns:	The active_license_record_count of this ProductLicenseSummary.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this ProductLicenseSummary. The compartment OCID where the product license is created.

Returns:	The compartment_id of this ProductLicenseSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ProductLicenseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ProductLicenseSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ProductLicenseSummary. License record name

Returns:	The display_name of this ProductLicenseSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ProductLicenseSummary. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ProductLicenseSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ProductLicenseSummary. The product license OCID.

Returns:	The id of this ProductLicenseSummary.
Return type:	str

images¶

Gets the images of this ProductLicenseSummary. The images associated with the product license.

Returns:	The images of this ProductLicenseSummary.
Return type:	list[oci.license_manager.models.ImageResponse]

is_over_subscribed¶

Gets the is_over_subscribed of this ProductLicenseSummary. Specifies whether or not the product license is oversubscribed.

Returns:	The is_over_subscribed of this ProductLicenseSummary.
Return type:	bool

is_unlimited¶

Gets the is_unlimited of this ProductLicenseSummary. Specifies if the license unit count is unlimited.

Returns:	The is_unlimited of this ProductLicenseSummary.
Return type:	bool

is_vendor_oracle¶

[Required] Gets the is_vendor_oracle of this ProductLicenseSummary. Specifies whether the vendor is Oracle or a third party.

Returns:	The is_vendor_oracle of this ProductLicenseSummary.
Return type:	bool

license_unit¶

[Required] Gets the license_unit of this ProductLicenseSummary. The product license unit.

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

Returns:	The license_unit of this ProductLicenseSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this ProductLicenseSummary. The current product license state.

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

Returns:	The lifecycle_state of this ProductLicenseSummary.
Return type:	str

status¶

[Required] Gets the status of this ProductLicenseSummary. The current product license status.

Allowed values for this property are: “INCOMPLETE”, “ISSUES_FOUND”, “WARNING”, “OK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this ProductLicenseSummary.
Return type:	str

status_description¶

Gets the status_description of this ProductLicenseSummary. Status description for the current product license status.

Returns:	The status_description of this ProductLicenseSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ProductLicenseSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ProductLicenseSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this ProductLicenseSummary. The time the product license was created. An RFC 3339-formatted datetime string.

Returns:	The time_created of this ProductLicenseSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this ProductLicenseSummary. The time the product license was updated. An RFC 3339-formatted datetime string.

Returns:	The time_updated of this ProductLicenseSummary.
Return type:	datetime

total_active_license_unit_count¶

Gets the total_active_license_unit_count of this ProductLicenseSummary. The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license.

Returns:	The total_active_license_unit_count of this ProductLicenseSummary.
Return type:	int

total_license_record_count¶

Gets the total_license_record_count of this ProductLicenseSummary. The number of license records associated with the product license.

Returns:	The total_license_record_count of this ProductLicenseSummary.
Return type:	int

total_license_units_consumed¶

Gets the total_license_units_consumed of this ProductLicenseSummary. The number of license units consumed. Updated after each allocation run.

Returns:	The total_license_units_consumed of this ProductLicenseSummary.
Return type:	float

vendor_name¶

Gets the vendor_name of this ProductLicenseSummary. The vendor of the ProductLicense

Returns:	The vendor_name of this ProductLicenseSummary.
Return type:	str