Class: OCI::OciControlCenter::OccMetricsClient
- Inherits:
-
Object
- Object
- OCI::OciControlCenter::OccMetricsClient
- Defined in:
- lib/oci/oci_control_center/occ_metrics_client.rb
Overview
OCI Control Center (OCC) service enables you to monitor the region-level cloud consumption and provides the region-level capacity data, in realms where OCC is available. Use the OCI Control Center (OCC) API to explore region-level capacity and utilization information about core services. For more information, see OCI Control Center.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OccMetricsClient
constructor
Creates a new OccMetricsClient.
-
#list_metric_properties(namespace_name, compartment_id, opts = {}) ⇒ Response
Returns a list of available metrics for the given namespace.
-
#list_namespaces(compartment_id, opts = {}) ⇒ Response
List all the available source services called namespaces emitting metrics for this region.
-
#logger ⇒ Logger
The logger for this client.
-
#request_summarized_metric_data(request_summarized_metric_data_details, opts = {}) ⇒ Response
Returns the summarized data for the given metric from the given namespace.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OccMetricsClient
Creates a new OccMetricsClient. 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.
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/oci_control_center/occ_metrics_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 + '/20230515' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "OccMetricsClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/oci_control_center/occ_metrics_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
25 26 27 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#list_metric_properties(namespace_name, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_metric_properties API.
Returns a list of available metrics for the given namespace. The results for metrics with dimensions includes list of all the associated dimensions. The results are sorted by the metricName and then by dimension in ascending alphabetical order. For a list of valid namespaces, see list_namespaces.
120 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 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 120 def list_metric_properties(namespace_name, compartment_id, opts = {}) logger.debug 'Calling operation OccMetricsClient#list_metric_properties.' if logger raise "Missing the required parameter 'namespace_name' when calling list_metric_properties." if namespace_name.nil? raise "Missing the required parameter 'compartment_id' when calling list_metric_properties." if compartment_id.nil? raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name) path = '/metricProperties/{namespaceName}'.sub('{namespaceName}', namespace_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccMetricsClient#list_metric_properties') 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::OciControlCenter::Models::MetricPropertyCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_namespaces(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_namespaces API.
List all the available source services called namespaces emitting metrics for this region. The namespaces are sorted in ascending alphabetical order.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 185 def list_namespaces(compartment_id, opts = {}) logger.debug 'Calling operation OccMetricsClient#list_namespaces.' if logger raise "Missing the required parameter 'compartment_id' when calling list_namespaces." if compartment_id.nil? path = '/namespaces' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # 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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccMetricsClient#list_namespaces') 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::OciControlCenter::Models::NamespaceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 94 def logger @api_client.config.logger end |
#request_summarized_metric_data(request_summarized_metric_data_details, opts = {}) ⇒ Response
Click here to see an example of how to use request_summarized_metric_data API.
Returns the summarized data for the given metric from the given namespace. The aggregation method depends on the metric. The metric data can be filtered by providing the dimension, startTime or endTime. The metric data in the response is sorted by dimension in ascending order and then by sampleTime in ascending chronological order.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/oci/oci_control_center/occ_metrics_client.rb', line 249 def request_summarized_metric_data(request_summarized_metric_data_details, opts = {}) logger.debug 'Calling operation OccMetricsClient#request_summarized_metric_data.' if logger raise "Missing the required parameter 'request_summarized_metric_data_details' when calling request_summarized_metric_data." if request_summarized_metric_data_details.nil? path = '/requestSummarizedMetricData' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # 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] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(request_summarized_metric_data_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccMetricsClient#request_summarized_metric_data') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::OciControlCenter::Models::SummarizedMetricDataCollection' ) end # rubocop:enable Metrics/BlockLength end |