Class: OCI::OsManagementHub::ReportingManagedInstanceClient
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::ReportingManagedInstanceClient
- Defined in:
- lib/oci/os_management_hub/reporting_managed_instance_client.rb
Overview
Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see Overview of OS Management Hub.
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
-
#get_managed_instance_analytic_content(opts = {}, &block) ⇒ Response
Returns a CSV format report of managed instances matching the given filters.
-
#get_managed_instance_content(managed_instance_id, opts = {}, &block) ⇒ Response
Returns a CSV format report of a single managed instance whose associated Erratas match the given filters.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ReportingManagedInstanceClient
constructor
Creates a new ReportingManagedInstanceClient.
-
#logger ⇒ Logger
The logger for this client.
-
#summarize_managed_instance_analytics(metric_names, opts = {}) ⇒ Response
Returns a list of user specified metrics for a collection of managed instances.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ReportingManagedInstanceClient
Creates a new ReportingManagedInstanceClient. 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/os_management_hub/reporting_managed_instance_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 + '/20220901' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ReportingManagedInstanceClient 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/os_management_hub/reporting_managed_instance_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/os_management_hub/reporting_managed_instance_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/os_management_hub/reporting_managed_instance_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/os_management_hub/reporting_managed_instance_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#get_managed_instance_analytic_content(opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_managed_instance_analytic_content API.
Returns a CSV format report of managed instances matching the given filters.
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 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 224 225 226 227 228 229 230 231 232 |
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 128 def get_managed_instance_analytic_content(opts = {}, &block) logger.debug 'Calling operation ReportingManagedInstanceClient#get_managed_instance_analytic_content.' if logger status_allowable_values = %w[NORMAL UNREACHABLE ERROR WARNING REGISTRATION_ERROR] if opts[:status] && !opts[:status].empty? opts[:status].each do |val_to_check| unless status_allowable_values.include?(val_to_check) raise 'Invalid value for "status", must be one of NORMAL, UNREACHABLE, ERROR, WARNING, REGISTRATION_ERROR.' end end end if opts[:instance_location] && !OCI::OsManagementHub::Models::MANAGED_INSTANCE_LOCATION_ENUM.include?(opts[:instance_location]) raise 'Invalid value for "instance_location", must be one of the values in OCI::OsManagementHub::Models::MANAGED_INSTANCE_LOCATION_ENUM.' end path = '/managedInstanceAnalytics/content' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:managedInstanceGroupId] = opts[:managed_instance_group_id] if opts[:managed_instance_group_id] query_params[:lifecycleEnvironmentId] = opts[:lifecycle_environment_id] if opts[:lifecycle_environment_id] query_params[:lifecycleStageId] = opts[:lifecycle_stage_id] if opts[:lifecycle_stage_id] query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty? query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty? query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] query_params[:instanceLocation] = opts[:instance_location] if opts[:instance_location] query_params[:securityUpdatesAvailableEqualsTo] = opts[:security_updates_available_equals_to] if opts[:security_updates_available_equals_to] query_params[:bugUpdatesAvailableEqualsTo] = opts[:bug_updates_available_equals_to] if opts[:bug_updates_available_equals_to] query_params[:securityUpdatesAvailableGreaterThan] = opts[:security_updates_available_greater_than] if opts[:security_updates_available_greater_than] query_params[:bugUpdatesAvailableGreaterThan] = opts[:bug_updates_available_greater_than] if opts[:bug_updates_available_greater_than] # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/x-yaml' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] 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: 'ReportingManagedInstanceClient#get_managed_instance_analytic_content') do if !block.nil? @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: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @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: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @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: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @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: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_managed_instance_content(managed_instance_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_managed_instance_content API.
Returns a CSV format report of a single managed instance whose associated Erratas match the given filters.
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 287 288 289 290 291 292 293 294 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 353 |
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 260 def get_managed_instance_content(managed_instance_id, opts = {}, &block) logger.debug 'Calling operation ReportingManagedInstanceClient#get_managed_instance_content.' if logger raise "Missing the required parameter 'managed_instance_id' when calling get_managed_instance_content." if managed_instance_id.nil? advisory_type_allowable_values = %w[SECURITY BUGFIX ENHANCEMENT] if opts[:advisory_type] && !opts[:advisory_type].empty? opts[:advisory_type].each do |val_to_check| unless advisory_type_allowable_values.include?(val_to_check) raise 'Invalid value for "advisory_type", must be one of SECURITY, BUGFIX, ENHANCEMENT.' end end end raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id) path = '/managedInstances/{managedInstanceId}/content'.sub('{managedInstanceId}', managed_instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:advisoryName] = OCI::ApiClient.build_collection_params(opts[:advisory_name], :multi) if opts[:advisory_name] && !opts[:advisory_name].empty? query_params[:advisoryNameContains] = opts[:advisory_name_contains] if opts[:advisory_name_contains] query_params[:advisoryType] = OCI::ApiClient.build_collection_params(opts[:advisory_type], :multi) if opts[:advisory_type] && !opts[:advisory_type].empty? # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'application/x-yaml' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] 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: 'ReportingManagedInstanceClient#get_managed_instance_content') do if !block.nil? @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: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @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: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @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: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @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: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 94 def logger @api_client.config.logger end |
#summarize_managed_instance_analytics(metric_names, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_managed_instance_analytics API.
Returns a list of user specified metrics for a collection of managed instances.
Allowed values are: name
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/oci/os_management_hub/reporting_managed_instance_client.rb', line 398 def summarize_managed_instance_analytics(metric_names, opts = {}) logger.debug 'Calling operation ReportingManagedInstanceClient#summarize_managed_instance_analytics.' if logger raise "Missing the required parameter 'metric_names' when calling summarize_managed_instance_analytics." if metric_names.nil? metric_names_allowable_values = %w[TOTAL_INSTANCE_COUNT INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT NORMAL_INSTANCE_COUNT ERROR_INSTANCE_COUNT WARNING_INSTANCE_COUNT UNREACHABLE_INSTANCE_COUNT REGISTRATION_FAILED_INSTANCE_COUNT INSTANCE_SECURITY_UPDATES_COUNT INSTANCE_BUGFIX_UPDATES_COUNT] metric_names.each do |val_to_check| unless metric_names_allowable_values.include?(val_to_check) raise "Invalid value for 'metric_names', must be one of TOTAL_INSTANCE_COUNT, INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT, INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT, NORMAL_INSTANCE_COUNT, ERROR_INSTANCE_COUNT, WARNING_INSTANCE_COUNT, UNREACHABLE_INSTANCE_COUNT, REGISTRATION_FAILED_INSTANCE_COUNT, INSTANCE_SECURITY_UPDATES_COUNT, INSTANCE_BUGFIX_UPDATES_COUNT." end end status_allowable_values = %w[NORMAL UNREACHABLE ERROR WARNING REGISTRATION_ERROR] if opts[:status] && !opts[:status].empty? opts[:status].each do |val_to_check| unless status_allowable_values.include?(val_to_check) raise 'Invalid value for "status", must be one of NORMAL, UNREACHABLE, ERROR, WARNING, REGISTRATION_ERROR.' end end end if opts[:instance_location] && !OCI::OsManagementHub::Models::MANAGED_INSTANCE_LOCATION_ENUM.include?(opts[:instance_location]) raise 'Invalid value for "instance_location", must be one of the values in OCI::OsManagementHub::Models::MANAGED_INSTANCE_LOCATION_ENUM.' end if opts[:sort_by] && !%w[name].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of name.' end if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::Models::SORT_ORDER_ENUM.' end path = '/managedInstanceAnalytics' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:metricNames] = OCI::ApiClient.build_collection_params(metric_names, :multi) query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:managedInstanceGroupId] = opts[:managed_instance_group_id] if opts[:managed_instance_group_id] query_params[:lifecycleEnvironmentId] = opts[:lifecycle_environment_id] if opts[:lifecycle_environment_id] query_params[:lifecycleStageId] = opts[:lifecycle_stage_id] if opts[:lifecycle_stage_id] query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty? query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty? query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains] query_params[:instanceLocation] = opts[:instance_location] if opts[:instance_location] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # 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: 'ReportingManagedInstanceClient#summarize_managed_instance_analytics') 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::OsManagementHub::Models::ManagedInstanceAnalyticCollection' ) end # rubocop:enable Metrics/BlockLength end |