Class: OCI::ApmConfig::ConfigClient
- Inherits:
-
Object
- Object
- OCI::ApmConfig::ConfigClient
- Defined in:
- lib/oci/apm_config/config_client.rb
Overview
Use the Application Performance Monitoring Configuration API to query and set Application Performance Monitoring configuration. For more information, see Application Performance Monitoring.
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
-
#create_config(apm_domain_id, create_config_details, opts = {}) ⇒ Response
Creates a new configuration item.
-
#delete_config(apm_domain_id, config_id, opts = {}) ⇒ Response
Deletes the configuration item identified by the OCID.
-
#get_config(apm_domain_id, config_id, opts = {}) ⇒ Response
Gets the configuration item identified by the OCID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ConfigClient
constructor
Creates a new ConfigClient.
-
#list_configs(apm_domain_id, opts = {}) ⇒ Response
Returns all configuration items, which can optionally be filtered by configuration type.
-
#logger ⇒ Logger
The logger for this client.
-
#retrieve_namespace_metrics(apm_domain_id, retrieve_namespace_metrics_details, opts = {}) ⇒ Response
Returns all metrics associated with the specified namespace.
-
#retrieve_namespaces(apm_domain_id, opts = {}) ⇒ Response
Returns all namespaces available in APM.
-
#update_config(apm_domain_id, config_id, update_config_details, opts = {}) ⇒ Response
Updates the details of the configuration item identified by the OCID.
-
#validate_span_filter_pattern(apm_domain_id, validate_span_filter_pattern_details, opts = {}) ⇒ Response
Validates the Span Filter pattern (filterText) for syntactic correctness.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ConfigClient
Creates a new ConfigClient. 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.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/apm_config/config_client.rb', line 56 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 + '/20210201' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ConfigClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/apm_config/config_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/apm_config/config_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/apm_config/config_client.rb', line 30 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
26 27 28 |
# File 'lib/oci/apm_config/config_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#create_config(apm_domain_id, create_config_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_config API.
Creates a new configuration item.
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 162 163 164 165 |
# File 'lib/oci/apm_config/config_client.rb', line 125 def create_config(apm_domain_id, create_config_details, opts = {}) logger.debug 'Calling operation ConfigClient#create_config.' if logger raise "Missing the required parameter 'apm_domain_id' when calling create_config." if apm_domain_id.nil? raise "Missing the required parameter 'create_config_details' when calling create_config." if create_config_details.nil? path = '/configs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-dry-run'] = opts[:opc_dry_run] if opts[:opc_dry_run] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_config_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ConfigClient#create_config') 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::ApmConfig::Models::Config' ) end # rubocop:enable Metrics/BlockLength end |
#delete_config(apm_domain_id, config_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_config API.
Deletes the configuration item identified by the OCID.
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/apm_config/config_client.rb', line 194 def delete_config(apm_domain_id, config_id, opts = {}) logger.debug 'Calling operation ConfigClient#delete_config.' if logger raise "Missing the required parameter 'apm_domain_id' when calling delete_config." if apm_domain_id.nil? raise "Missing the required parameter 'config_id' when calling delete_config." if config_id.nil? raise "Parameter value for 'config_id' must not be blank" if OCI::Internal::Util.blank_string?(config_id) path = '/configs/{configId}'.sub('{configId}', config_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] 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: 'ConfigClient#delete_config') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_config(apm_domain_id, config_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_config API.
Gets the configuration item identified by the OCID.
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 287 288 289 290 291 292 293 |
# File 'lib/oci/apm_config/config_client.rb', line 255 def get_config(apm_domain_id, config_id, opts = {}) logger.debug 'Calling operation ConfigClient#get_config.' if logger raise "Missing the required parameter 'apm_domain_id' when calling get_config." if apm_domain_id.nil? raise "Missing the required parameter 'config_id' when calling get_config." if config_id.nil? raise "Parameter value for 'config_id' must not be blank" if OCI::Internal::Util.blank_string?(config_id) path = '/configs/{configId}'.sub('{configId}', config_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # 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: 'ConfigClient#get_config') 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::ApmConfig::Models::Config' ) end # rubocop:enable Metrics/BlockLength end |
#list_configs(apm_domain_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_configs API.
Returns all configuration items, which can optionally be filtered by configuration type.
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'lib/oci/apm_config/config_client.rb', line 352 def list_configs(apm_domain_id, opts = {}) logger.debug 'Calling operation ConfigClient#list_configs.' if logger raise "Missing the required parameter 'apm_domain_id' when calling list_configs." if apm_domain_id.nil? if opts[:sort_order] && !OCI::ApmConfig::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ApmConfig::Models::SORT_ORDERS_ENUM.' end if opts[:sort_by] && !%w[displayName timeCreated timeUpdated].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, timeUpdated.' end path = '/configs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id query_params[:configType] = opts[:config_type] if opts[:config_type] query_params[:displayName] = opts[:display_name] if opts[:display_name] 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] query_params[:optionsGroup] = opts[:options_group] if opts[:options_group] query_params[:definedTagEquals] = OCI::ApiClient.build_collection_params(opts[:defined_tag_equals], :multi) if opts[:defined_tag_equals] && !opts[:defined_tag_equals].empty? query_params[:freeformTagEquals] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_equals], :multi) if opts[:freeform_tag_equals] && !opts[:freeform_tag_equals].empty? query_params[:definedTagExists] = OCI::ApiClient.build_collection_params(opts[:defined_tag_exists], :multi) if opts[:defined_tag_exists] && !opts[:defined_tag_exists].empty? query_params[:freeformTagExists] = OCI::ApiClient.build_collection_params(opts[:freeform_tag_exists], :multi) if opts[:freeform_tag_exists] && !opts[:freeform_tag_exists].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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ConfigClient#list_configs') 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::ApmConfig::Models::ConfigCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/apm_config/config_client.rb', line 95 def logger @api_client.config.logger end |
#retrieve_namespace_metrics(apm_domain_id, retrieve_namespace_metrics_details, opts = {}) ⇒ Response
Click here to see an example of how to use retrieve_namespace_metrics API.
Returns all metrics associated with the specified namespace.
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 |
# File 'lib/oci/apm_config/config_client.rb', line 429 def retrieve_namespace_metrics(apm_domain_id, retrieve_namespace_metrics_details, opts = {}) logger.debug 'Calling operation ConfigClient#retrieve_namespace_metrics.' if logger raise "Missing the required parameter 'apm_domain_id' when calling retrieve_namespace_metrics." if apm_domain_id.nil? raise "Missing the required parameter 'retrieve_namespace_metrics_details' when calling retrieve_namespace_metrics." if retrieve_namespace_metrics_details.nil? path = '/actions/retrieveNamespaceMetrics' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # 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(retrieve_namespace_metrics_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ConfigClient#retrieve_namespace_metrics') 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::ApmConfig::Models::NamespaceMetricCollection' ) end # rubocop:enable Metrics/BlockLength end |
#retrieve_namespaces(apm_domain_id, opts = {}) ⇒ Response
Click here to see an example of how to use retrieve_namespaces API.
Returns all namespaces available in APM.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/oci/apm_config/config_client.rb', line 487 def retrieve_namespaces(apm_domain_id, opts = {}) logger.debug 'Calling operation ConfigClient#retrieve_namespaces.' if logger raise "Missing the required parameter 'apm_domain_id' when calling retrieve_namespaces." if apm_domain_id.nil? path = '/actions/retrieveNamespaces' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # 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: 'ConfigClient#retrieve_namespaces') 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::ApmConfig::Models::NamespaceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#update_config(apm_domain_id, config_id, update_config_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_config API.
Updates the details of the configuration item identified by the OCID.
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 |
# File 'lib/oci/apm_config/config_client.rb', line 556 def update_config(apm_domain_id, config_id, update_config_details, opts = {}) logger.debug 'Calling operation ConfigClient#update_config.' if logger raise "Missing the required parameter 'apm_domain_id' when calling update_config." if apm_domain_id.nil? raise "Missing the required parameter 'config_id' when calling update_config." if config_id.nil? raise "Missing the required parameter 'update_config_details' when calling update_config." if update_config_details.nil? raise "Parameter value for 'config_id' must not be blank" if OCI::Internal::Util.blank_string?(config_id) path = '/configs/{configId}'.sub('{configId}', config_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-dry-run'] = opts[:opc_dry_run] if opts[:opc_dry_run] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_config_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ConfigClient#update_config') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ApmConfig::Models::Config' ) end # rubocop:enable Metrics/BlockLength end |
#validate_span_filter_pattern(apm_domain_id, validate_span_filter_pattern_details, opts = {}) ⇒ Response
Click here to see an example of how to use validate_span_filter_pattern API.
Validates the Span Filter pattern (filterText) for syntactic correctness. Returns 204 on success, 422 when validation fails.
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 |
# File 'lib/oci/apm_config/config_client.rb', line 621 def validate_span_filter_pattern(apm_domain_id, validate_span_filter_pattern_details, opts = {}) logger.debug 'Calling operation ConfigClient#validate_span_filter_pattern.' if logger raise "Missing the required parameter 'apm_domain_id' when calling validate_span_filter_pattern." if apm_domain_id.nil? raise "Missing the required parameter 'validate_span_filter_pattern_details' when calling validate_span_filter_pattern." if validate_span_filter_pattern_details.nil? path = '/actions/validateSpanFilterPattern' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id # 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(validate_span_filter_pattern_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ConfigClient#validate_span_filter_pattern') 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 ) end # rubocop:enable Metrics/BlockLength end |