ComputedUsageClient

class oci.osub_usage.ComputedUsageClient(config, **kwargs)

OneSubscription API Common set of Subscription Plan Management (SPM) Usage Computation resources

Methods

__init__(config, **kwargs) Creates a new service client
get_computed_usage(computed_usage_id, …) This is an API which returns Computed Usage corresponding to the id passed
list_computed_usage_aggregateds(…) This is a collection API which returns a list of aggregated computed usage details (there can be multiple Parent Products under a given SubID each of which is represented under Subscription Service Line # in SPM).
list_computed_usages(compartment_id, …) This is a collection API which returns a list of Computed Usages for given filters.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
get_computed_usage(computed_usage_id, compartment_id, **kwargs)

This is an API which returns Computed Usage corresponding to the id passed

Parameters:
  • computed_usage_id (str) – (required) The Computed Usage Id
  • compartment_id (str) – (required) The OCID of the root compartment.
  • fields (list[str]) – (optional) Partial response refers to an optimization technique offered by the RESTful web APIs to return only the information (fields) required by the client. This parameter is used to control what fields to return.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • x_one_origin_region (str) – (optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ComputedUsage
Return type:

Response
Example:

Click here to see an example of how to use get_computed_usage API.

list_computed_usage_aggregateds(compartment_id, subscription_id, time_from, time_to, **kwargs)

This is a collection API which returns a list of aggregated computed usage details (there can be multiple Parent Products under a given SubID each of which is represented under Subscription Service Line # in SPM).

Parameters:
  • compartment_id (str) – (required) The OCID of the root compartment.
  • subscription_id (str) – (required) Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.
  • time_from (datetime) – (required) Initial date to filter Computed Usage data in SPM. In the case of non aggregated data the time period between of fromDate and toDate , expressed in RFC 3339 timestamp format.
  • time_to (datetime) – (required) Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.
  • parent_product (str) – (optional) Product part number for subscribed service line, called parent product.
  • grouping (str) –

    (optional) Grouping criteria to use for aggregate the computed Usage, either hourly (HOURLY), daily (DAILY), monthly(MONTHLY) or none (NONE) to not follow a grouping criteria by date.

    Allowed values are: “HOURLY”, “DAILY”, “MONTHLY”, “NONE”

  • limit (int) – (optional) The maximum number aggregatedComputedUsages of items to return within the Subscription “List” call, this counts the overall count across all items Example: 500
  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • x_one_origin_region (str) – (optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of ComputedUsageAggregatedSummary
Return type:

Response
Example:

Click here to see an example of how to use list_computed_usage_aggregateds API.

list_computed_usages(compartment_id, subscription_id, time_from, time_to, **kwargs)

This is a collection API which returns a list of Computed Usages for given filters.

Parameters:
  • compartment_id (str) – (required) The OCID of the root compartment.
  • subscription_id (str) – (required) Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.
  • time_from (datetime) – (required) Initial date to filter Computed Usage data in SPM. In the case of non aggregated data the time period between of fromDate and toDate , expressed in RFC 3339 timestamp format.
  • time_to (datetime) – (required) Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.
  • parent_product (str) – (optional) Product part number for subscribed service line, called parent product.
  • computed_product (str) – (optional) Product part number for Computed Usage .
  • limit (int) –

    (optional) The maximum number of items to return in a paginated “List” call.

    Example: 500

  • page (str) – (optional) The value of the opc-next-page response header from the previous “List” call.
  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder).

    Allowed values are: “timeCreated”, “timeOfArrival”, “timeMeteredOn”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • x_one_origin_region (str) – (optional) The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of ComputedUsageSummary
Return type:

Response
Example:

Click here to see an example of how to use list_computed_usages API.