Class: OCI::OsubUsage::ComputedUsageClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/osub_usage/computed_usage_client.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ComputedUsageClient

Creates a new ComputedUsageClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/oalapp/service/onesubs/proxy/20210501'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ComputedUsageClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#get_computed_usage(computed_usage_id, compartment_id, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • computed_usage_id (String) —

    The Computed Usage Id

  • compartment_id (String) —

    The OCID of the root compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :fields (Array<String>) —

    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 (String) —

    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 (String) —

    The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 121

def get_computed_usage(computed_usage_id, compartment_id, opts = {})
  logger.debug 'Calling operation ComputedUsageClient#get_computed_usage.' if logger

  raise "Missing the required parameter 'computed_usage_id' when calling get_computed_usage." if computed_usage_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_computed_usage." if compartment_id.nil?
  raise "Parameter value for 'computed_usage_id' must not be blank" if OCI::Internal::Util.blank_string?(computed_usage_id)

  path = '/computedUsages/{computedUsageId}'.sub('{computedUsageId}', computed_usage_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'x-one-origin-region'] = opts[:x_one_origin_region] if opts[:x_one_origin_region]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ComputedUsageClient#get_computed_usage') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OsubUsage::Models::ComputedUsage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_computed_usage_aggregateds(compartment_id, subscription_id, time_from, time_to, opts = {}) ⇒ Response

Note:

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

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).

Allowed values are: HOURLY, DAILY, MONTHLY, NONE

Parameters:

  • compartment_id (String) —

    The OCID of the root compartment.

  • subscription_id (String) —

    Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.

  • time_from (DateTime) —

    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) —

    Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :parent_product (String) —

    Product part number for subscribed service line, called parent product.

  • :grouping (String) —

    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. (default to MONTHLY)

  • :limit (Integer) —

    The maximum number aggregatedComputedUsages of items to return within the Subscription "List" call, this counts the overall count across all items Example: 500 (default to 1000)

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call.

  • :opc_request_id (String) —

    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 (String) —

    The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 200

def list_computed_usage_aggregateds(compartment_id, subscription_id, time_from, time_to, opts = {})
  logger.debug 'Calling operation ComputedUsageClient#list_computed_usage_aggregateds.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_computed_usage_aggregateds." if compartment_id.nil?
  raise "Missing the required parameter 'subscription_id' when calling list_computed_usage_aggregateds." if subscription_id.nil?
  raise "Missing the required parameter 'time_from' when calling list_computed_usage_aggregateds." if time_from.nil?
  raise "Missing the required parameter 'time_to' when calling list_computed_usage_aggregateds." if time_to.nil?

  if opts[:grouping] && !%w[HOURLY DAILY MONTHLY NONE].include?(opts[:grouping])
    raise 'Invalid value for "grouping", must be one of HOURLY, DAILY, MONTHLY, NONE.'
  end

  path = '/computedUsages/aggregated'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:subscriptionId] = subscription_id
  query_params[:timeFrom] = time_from
  query_params[:timeTo] = time_to
  query_params[:parentProduct] = opts[:parent_product] if opts[:parent_product]
  query_params[:grouping] = opts[:grouping] if opts[:grouping]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'x-one-origin-region'] = opts[:x_one_origin_region] if opts[:x_one_origin_region]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ComputedUsageClient#list_computed_usage_aggregateds') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::OsubUsage::Models::ComputedUsageAggregatedSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_computed_usages(compartment_id, subscription_id, time_from, time_to, opts = {}) ⇒ Response

Note:

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

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

Allowed values are: ASC, DESC Allowed values are: timeCreated, timeOfArrival, timeMeteredOn

Parameters:

  • compartment_id (String) —

    The OCID of the root compartment.

  • subscription_id (String) —

    Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM.

  • time_from (DateTime) —

    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) —

    Final date to filter Computed Usage data in SPM, expressed in RFC 3339 timestamp format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :parent_product (String) —

    Product part number for subscribed service line, called parent product.

  • :computed_product (String) —

    Product part number for Computed Usage .

  • :limit (Integer) —

    The maximum number of items to return in a paginated "List" call.

    Example: 500 (default to 1000)

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call.

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    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 (String) —

    The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

Returns:



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 295

def list_computed_usages(compartment_id, subscription_id, time_from, time_to, opts = {})
  logger.debug 'Calling operation ComputedUsageClient#list_computed_usages.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_computed_usages." if compartment_id.nil?
  raise "Missing the required parameter 'subscription_id' when calling list_computed_usages." if subscription_id.nil?
  raise "Missing the required parameter 'time_from' when calling list_computed_usages." if time_from.nil?
  raise "Missing the required parameter 'time_to' when calling list_computed_usages." if time_to.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated timeOfArrival timeMeteredOn].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeOfArrival, timeMeteredOn.'
  end

  path = '/computedUsages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:subscriptionId] = subscription_id
  query_params[:timeFrom] = time_from
  query_params[:timeTo] = time_to
  query_params[:parentProduct] = opts[:parent_product] if opts[:parent_product]
  query_params[:computedProduct] = opts[:computed_product] if opts[:computed_product]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'x-one-origin-region'] = opts[:x_one_origin_region] if opts[:x_one_origin_region]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ComputedUsageClient#list_computed_usages') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::OsubUsage::Models::ComputedUsageSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/osub_usage/computed_usage_client.rb', line 94

def logger
  @api_client.config.logger
end