OccOverviewSummary¶

class oci.capacity_management.models.OccOverviewSummary(**kwargs)¶

Bases: object

The overview summary is used to represent an array item that shall be used to represent the overview of the catalog resources along with their corresponding capacity requests.

Methods

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

Attributes

`capacity_requests_blob`	Gets the capacity_requests_blob of this OccOverviewSummary.
`compartment_id`	[Required] Gets the compartment_id of this OccOverviewSummary.
`period_value`	[Required] Gets the period_value of this OccOverviewSummary.
`resource_name`	[Required] Gets the resource_name of this OccOverviewSummary.
`total_available`	[Required] Gets the total_available of this OccOverviewSummary.
`total_cancelled`	[Required] Gets the total_cancelled of this OccOverviewSummary.
`total_demanded`	[Required] Gets the total_demanded of this OccOverviewSummary.
`total_rejected`	[Required] Gets the total_rejected of this OccOverviewSummary.
`total_supplied`	[Required] Gets the total_supplied of this OccOverviewSummary.
`total_unfulfilled`	[Required] Gets the total_unfulfilled of this OccOverviewSummary.
`unit`	[Required] Gets the unit of this OccOverviewSummary.
`workload_type_breakdown_blob`	[Required] Gets the workload_type_breakdown_blob of this OccOverviewSummary.

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this OccOverviewSummary.
period_value (str) – The value to assign to the period_value property of this OccOverviewSummary.
resource_name (str) – The value to assign to the resource_name property of this OccOverviewSummary.
total_available (int) – The value to assign to the total_available property of this OccOverviewSummary.
total_demanded (int) – The value to assign to the total_demanded property of this OccOverviewSummary.
total_supplied (int) – The value to assign to the total_supplied property of this OccOverviewSummary.
total_rejected (int) – The value to assign to the total_rejected property of this OccOverviewSummary.
total_cancelled (int) – The value to assign to the total_cancelled property of this OccOverviewSummary.
total_unfulfilled (int) – The value to assign to the total_unfulfilled property of this OccOverviewSummary.
workload_type_breakdown_blob (str) – The value to assign to the workload_type_breakdown_blob property of this OccOverviewSummary.
capacity_requests_blob (str) – The value to assign to the capacity_requests_blob property of this OccOverviewSummary.
unit (str) – The value to assign to the unit property of this OccOverviewSummary.

capacity_requests_blob¶

Gets the capacity_requests_blob of this OccOverviewSummary. A raw json blob containing all the capacity requests corresponding to the resource name

Returns:	The capacity_requests_blob of this OccOverviewSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this OccOverviewSummary. The OCID of the compartment from which the api call is made. This will be used for authorizing the request.

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

period_value¶

[Required] Gets the period_value of this OccOverviewSummary. The name of the month along with year for which this summary corresponds to.

Returns:	The period_value of this OccOverviewSummary.
Return type:	str

resource_name¶

[Required] Gets the resource_name of this OccOverviewSummary. The name of the resource for which we have aggregated the value.

Returns:	The resource_name of this OccOverviewSummary.
Return type:	str

total_available¶

[Required] Gets the total_available of this OccOverviewSummary. The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.

Returns:	The total_available of this OccOverviewSummary.
Return type:	int

total_cancelled¶

[Required] Gets the total_cancelled of this OccOverviewSummary. The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.

Returns:	The total_cancelled of this OccOverviewSummary.
Return type:	int

total_demanded¶

[Required] Gets the total_demanded of this OccOverviewSummary. The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.

Returns:	The total_demanded of this OccOverviewSummary.
Return type:	int

total_rejected¶

[Required] Gets the total_rejected of this OccOverviewSummary. The quantity of the resource which is rejected by Oracle.

Returns:	The total_rejected of this OccOverviewSummary.
Return type:	int

total_supplied¶

[Required] Gets the total_supplied of this OccOverviewSummary. The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.

Returns:	The total_supplied of this OccOverviewSummary.
Return type:	int

total_unfulfilled¶

[Required] Gets the total_unfulfilled of this OccOverviewSummary. The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.

Returns:	The total_unfulfilled of this OccOverviewSummary.
Return type:	int

unit¶

[Required] Gets the unit of this OccOverviewSummary. The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.

Returns:	The unit of this OccOverviewSummary.
Return type:	str

workload_type_breakdown_blob¶

[Required] Gets the workload_type_breakdown_blob of this OccOverviewSummary. A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types

Returns:	The workload_type_breakdown_blob of this OccOverviewSummary.
Return type:	str