Class: OCI::ApmConfig::ConfigClient

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

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.

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



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.

Returns:



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

Returns:

  • (String) 


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.

Returns:

  • (String) 


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

Returns:



26
27
28
 
# File 'lib/oci/apm_config/config_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#copy_configuration(copy_configuration_details, apm_domain_id, apm_target_domain_id, opts = {}) ⇒ Response

Note:

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

Fast importing configuration items to a destination APM domain ID.

Parameters:

  • copy_configuration_details (OCI::ApmConfig::Models::CopyConfigurationDetails) —

    JSON metadata for fast Export/Import configurations domain.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • apm_target_domain_id (String) —

    The Target APM Domain ID the request is intended for.

  • 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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
162
163
164
 
# File 'lib/oci/apm_config/config_client.rb', line 123

def copy_configuration(copy_configuration_details, apm_domain_id, apm_target_domain_id, opts = {})
  logger.debug 'Calling operation ConfigClient#copy_configuration.' if logger

  raise "Missing the required parameter 'copy_configuration_details' when calling copy_configuration." if copy_configuration_details.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling copy_configuration." if apm_domain_id.nil?
  raise "Missing the required parameter 'apm_target_domain_id' when calling copy_configuration." if apm_target_domain_id.nil?

  path = '/actions/copyConfiguration'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:apmTargetDomainId] = apm_target_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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(copy_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#copy_configuration') 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::ImportConfigurationFailedItemsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_config(apm_domain_id, create_config_details, opts = {}) ⇒ Response

Note:

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

Creates a new configuration item.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • create_config_details (OCI::ApmConfig::Models::CreateConfigDetails) —

    The configuration details of the new item.

  • 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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_dry_run (String) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data. (default to false)

Returns:



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
233
234
235
 
# File 'lib/oci/apm_config/config_client.rb', line 195

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.make_retrying_call(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

Note:

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

Deletes the configuration item identified by the OCID.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • config_id (String) —

    The OCID of the configuration item.

  • 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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/apm_config/config_client.rb', line 264

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.make_retrying_call(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

#delete_data_file(data_file_name, apm_domain_id, apm_type, opts = {}) ⇒ Response

Note:

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

Removes the data file.

Parameters:

  • data_file_name (String) —

    The name of the data file.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • apm_type (String) —

    The type of the data file.

  • 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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
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
 
# File 'lib/oci/apm_config/config_client.rb', line 336

def delete_data_file(data_file_name, apm_domain_id, apm_type, opts = {})
  logger.debug 'Calling operation ConfigClient#delete_data_file.' if logger

  raise "Missing the required parameter 'data_file_name' when calling delete_data_file." if data_file_name.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling delete_data_file." if apm_domain_id.nil?
  raise "Missing the required parameter 'apm_type' when calling delete_data_file." if apm_type.nil?
  raise "Parameter value for 'data_file_name' must not be blank" if OCI::Internal::Util.blank_string?(data_file_name)

  path = '/dataFiles/{dataFileName}'.sub('{dataFileName}', data_file_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:apmType] = apm_type

  # 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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#delete_data_file') 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

#export_configuration(export_configuration_details, apm_domain_id, opts = {}) ⇒ Response

Note:

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

Exports configurations for the whole domain by domainId.

Parameters:

  • export_configuration_details (OCI::ApmConfig::Models::ExportConfigurationDetails) —

    JSON metadata for exporting configurations domain.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • 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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
 
# File 'lib/oci/apm_config/config_client.rb', line 406

def export_configuration(export_configuration_details, apm_domain_id, opts = {})
  logger.debug 'Calling operation ConfigClient#export_configuration.' if logger

  raise "Missing the required parameter 'export_configuration_details' when calling export_configuration." if export_configuration_details.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling export_configuration." if apm_domain_id.nil?

  path = '/actions/exportConfiguration'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(export_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#export_configuration') 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::ExportConfigurationResponseDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_config(apm_domain_id, config_id, opts = {}) ⇒ Response

Note:

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

Gets the configuration item identified by the OCID.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • config_id (String) —

    The OCID of the configuration item.

  • 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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/oci/apm_config/config_client.rb', line 468

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.make_retrying_call(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

#get_data_file(data_file_name, apm_domain_id, apm_type, opts = {}, &block) ⇒ Response

Note:

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

Retrieves the Data file with the specified name and type.

Parameters:

  • data_file_name (String) —

    The name of the data file.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • apm_type (String) —

    The type of the data file.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/oci/apm_config/config_client.rb', line 536

def get_data_file(data_file_name, apm_domain_id, apm_type, opts = {}, &block)
  logger.debug 'Calling operation ConfigClient#get_data_file.' if logger

  raise "Missing the required parameter 'data_file_name' when calling get_data_file." if data_file_name.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling get_data_file." if apm_domain_id.nil?
  raise "Missing the required parameter 'apm_type' when calling get_data_file." if apm_type.nil?
  raise "Parameter value for 'data_file_name' must not be blank" if OCI::Internal::Util.blank_string?(data_file_name)

  path = '/dataFiles/{dataFileName}'.sub('{dataFileName}', data_file_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:apmType] = apm_type

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#get_data_file') 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_match_agents_with_attribute_key(apm_domain_id, opts = {}) ⇒ Response

Note:

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

The domain-wide agents matching attribute key.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • 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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/oci/apm_config/config_client.rb', line 643

def get_match_agents_with_attribute_key(apm_domain_id, opts = {})
  logger.debug 'Calling operation ConfigClient#get_match_agents_with_attribute_key.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling get_match_agents_with_attribute_key." if apm_domain_id.nil?

  path = '/actions/matchAgentsWithAttributeKey'
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#get_match_agents_with_attribute_key') 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::MatchAgentsWithAttributeKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#head_data_file(data_file_name, apm_domain_id, apm_type, opts = {}) ⇒ Response

Note:

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

Returns metadata about the datafile.

Parameters:

  • data_file_name (String) —

    The name of the data file.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • apm_type (String) —

    The type of the data file.

  • 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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/oci/apm_config/config_client.rb', line 707

def head_data_file(data_file_name, apm_domain_id, apm_type, opts = {})
  logger.debug 'Calling operation ConfigClient#head_data_file.' if logger

  raise "Missing the required parameter 'data_file_name' when calling head_data_file." if data_file_name.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling head_data_file." if apm_domain_id.nil?
  raise "Missing the required parameter 'apm_type' when calling head_data_file." if apm_type.nil?
  raise "Parameter value for 'data_file_name' must not be blank" if OCI::Internal::Util.blank_string?(data_file_name)

  path = '/dataFiles/{dataFileName}'.sub('{dataFileName}', data_file_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:apmType] = apm_type

  # 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-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#head_data_file') do
    @api_client.call_api(
      :HEAD,
      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

#import_configuration(import_configuration_details, apm_domain_id, opts = {}) ⇒ Response

Note:

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

Import configurations Item(s) with its dependencies into a destination domain.

Parameters:

  • import_configuration_details (OCI::ApmConfig::Models::ImportConfigurationDetails) —

    JSON metadata for importing configurations domain.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • 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

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/oci/apm_config/config_client.rb', line 776

def import_configuration(import_configuration_details, apm_domain_id, opts = {})
  logger.debug 'Calling operation ConfigClient#import_configuration.' if logger

  raise "Missing the required parameter 'import_configuration_details' when calling import_configuration." if import_configuration_details.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling import_configuration." if apm_domain_id.nil?

  path = '/actions/importConfiguration'
  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]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#import_configuration') 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::ImportConfigurationFailedItemsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_configs(apm_domain_id, opts = {}) ⇒ Response

Note:

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.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • 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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :config_type (String) —

    A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, AGENT and MACS_APM_EXTENSION.

  • :display_name (String) —

    A filter to return resources that match the given display name.

  • :limit (Integer) —

    The maximum number of items to return. (default to 100)

  • :page (String) —

    The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination. Example: 50 (default to 50)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The displayName sort order is case-sensitive. (default to ASC)

  • :sort_by (String) —

    The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive. (default to displayName) Allowed values are: displayName, timeCreated, timeUpdated

  • :options_group (String) —

    A filter to return OPTIONS resources that match the given group.

  • :defined_tag_equals (Array<String>) —

    A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "namespace.tagName.value". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

  • :freeform_tag_equals (Array<String>) —

    A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "tagName.value". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".

  • :defined_tag_exists (Array<String>) —

    A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "namespace.tagName.true" (for checking existence of a defined tag) or "namespace.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

  • :freeform_tag_exists (Array<String>) —

    A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "tagName.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
 
# File 'lib/oci/apm_config/config_client.rb', line 874

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.make_retrying_call(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

#list_data_files(apm_domain_id, opts = {}) ⇒ Response

Note:

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

Fetches a list of Data files using some parameters.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • 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

  • :apm_type (String) —

    The type of the data file.

  • :name (String) —

    A filter to return resources that match the specified name. Supports regular expressions to filter data files.

  • :time_last_modified_before (DateTime) —

    Return data files with time 'timeLastModified' before the specified time, expressed in RFC 3339 timestamp format. Example: 2020-02-19T22:47:12.613Z

  • :time_last_modified_after (DateTime) —

    Return data files with the 'timeLastModified' after the specified time, expressed in RFC 3339 timestamp format. Example: 2020-02-19T22:47:12.613Z

  • :limit (Integer) —

    The maximum number of items to return. (default to 100)

  • :page (String) —

    The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination. Example: 50 (default to 50)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The displayName sort order is case-sensitive. (default to ASC)

  • :sort_by (String) —

    The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive. (default to displayName) Allowed values are: displayName, timeCreated, timeUpdated

  • :metadata (String) —

    A string containing a JSON-encoded object with metadata related to the uploaded file or resource. Example: "fileName":"report.pdf","uploader":"jane.doe","category":"financial"

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/oci/apm_config/config_client.rb', line 981

def list_data_files(apm_domain_id, opts = {})
  logger.debug 'Calling operation ConfigClient#list_data_files.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling list_data_files." 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 = '/dataFiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:apmType] = opts[:apm_type] if opts[:apm_type]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:timeLastModifiedBefore] = opts[:time_last_modified_before] if opts[:time_last_modified_before]
  query_params[:timeLastModifiedAfter] = opts[:time_last_modified_after] if opts[:time_last_modified_after]
  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[:metadata] = opts[:metadata] if opts[:metadata]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#list_data_files') 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::DataFileSummaryCollection'
    )
  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.



95
96
97
 
# File 'lib/oci/apm_config/config_client.rb', line 95

def logger
  @api_client.config.logger
end

#put_data_file(put_data_file_body, data_file_name, apm_domain_id, apm_type, opts = {}) ⇒ Response

Note:

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

Creates a new data file or replaces an existing one with the same name and type.

Parameters:

  • put_data_file_body (String, IO) —

    The data file to be uploaded.

  • data_file_name (String) —

    The name of the data file.

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • apm_type (String) —

    The type of the data file.

  • 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

  • :content_md5 (String) —

    Optional base64-encoded MD5 hash of the request body. If provided, the server will perform a data integrity check by computing the MD5 of the received content and comparing it to the supplied value.

    If the values do not match, the request will be rejected with an HTTP 400 error and a message such as:

    "The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)"

  • :content_type (String) —

    Optional parameter specifying the media type (MIME type) of the request or response body. If not specified, the default is application/octet-stream.

    This value can be used by recipients to determine how to interpret or render the content.

  • :content_language (String) —

    Optional parameter that indicates the natural language of the content. This value can be used by clients or intermediaries to select or display content based on language preferences.

  • :content_encoding (String) —

    Optional parameter indicating the content encodings applied to the request body (e.g., gzip, deflate). This value can be used by recipients to determine how to decode the content.

  • :content_disposition (String) —

    Optional parameter that provides presentation information for how the content should be displayed or handled by the recipient.

    For example, to prompt a file download with a custom filename: attachment; filename=\"example.txt\"

  • :metadata (String) —

    A string containing a JSON-encoded object with metadata related to the uploaded file or resource. Example: "fileName":"report.pdf","uploader":"jane.doe","category":"financial"

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_client_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/oci/apm_config/config_client.rb', line 1093

def put_data_file(put_data_file_body, data_file_name, apm_domain_id, apm_type, opts = {})
  logger.debug 'Calling operation ConfigClient#put_data_file.' if logger

  raise "Missing the required parameter 'put_data_file_body' when calling put_data_file." if put_data_file_body.nil?
  raise "Missing the required parameter 'data_file_name' when calling put_data_file." if data_file_name.nil?
  raise "Missing the required parameter 'apm_domain_id' when calling put_data_file." if apm_domain_id.nil?
  raise "Missing the required parameter 'apm_type' when calling put_data_file." if apm_type.nil?
  raise "Parameter value for 'data_file_name' must not be blank" if OCI::Internal::Util.blank_string?(data_file_name)

  path = '/dataFiles/{dataFileName}'.sub('{dataFileName}', data_file_name.to_s)
  operation_signing_strategy = :exclude_body

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:apmType] = apm_type

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-md5'] = opts[:content_md5] if opts[:content_md5]
  header_params[:'content-type'] = opts[:content_type] if opts[:content_type]
  header_params[:'content-language'] = opts[:content_language] if opts[:content_language]
  header_params[:'content-encoding'] = opts[:content_encoding] if opts[:content_encoding]
  header_params[:'content-disposition'] = opts[:content_disposition] if opts[:content_disposition]
  header_params[:metadata] = opts[:metadata] if opts[:metadata]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-client-request-id'] = opts[:opc_client_request_id] if opts[:opc_client_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(put_data_file_body)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#put_data_file') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#retrieve_namespace_metrics(apm_domain_id, retrieve_namespace_metrics_details, opts = {}) ⇒ Response

Note:

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

Returns all metrics associated with the specified namespace.

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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/oci/apm_config/config_client.rb', line 1163

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.make_retrying_call(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

Note:

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

Returns all namespaces available in APM.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • 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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/oci/apm_config/config_client.rb', line 1221

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.make_retrying_call(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

#test(apm_domain_id, test_details, opts = {}) ⇒ Response

Note:

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

Tests a data processing operation on the provided input, returning the potentially modified input as output. Returns 200 on success, 422 when the input can not be processed.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • test_details (OCI::ApmConfig::Models::TestDetails) —

    The test input.

  • 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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'lib/oci/apm_config/config_client.rb', line 1281

def test(apm_domain_id, test_details, opts = {})
  logger.debug 'Calling operation ConfigClient#test.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling test." if apm_domain_id.nil?
  raise "Missing the required parameter 'test_details' when calling test." if test_details.nil?

  path = '/actions/test'
  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(test_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#test') 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::TestOutput'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_config(apm_domain_id, config_id, update_config_details, opts = {}) ⇒ Response

Note:

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

Updates the details of the configuration item identified by the OCID.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID the request is intended for.

  • config_id (String) —

    The OCID of the configuration item.

  • update_config_details (OCI::ApmConfig::Models::UpdateConfigDetails) —

    The configuration details to be updated.

  • 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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_dry_run (String) —

    Indicates that the request is a dry run, if set to "true". A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data. (default to false)

Returns:



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/oci/apm_config/config_client.rb', line 1351

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.make_retrying_call(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

#update_match_agents_with_attribute_key(apm_domain_id, update_match_agents_with_attribute_key_details, opts = {}) ⇒ Response

Note:

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

Updates the agent matching attribute key for the APM Domain.

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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/oci/apm_config/config_client.rb', line 1414

def update_match_agents_with_attribute_key(apm_domain_id, update_match_agents_with_attribute_key_details, opts = {})
  logger.debug 'Calling operation ConfigClient#update_match_agents_with_attribute_key.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling update_match_agents_with_attribute_key." if apm_domain_id.nil?
  raise "Missing the required parameter 'update_match_agents_with_attribute_key_details' when calling update_match_agents_with_attribute_key." if update_match_agents_with_attribute_key_details.nil?

  path = '/actions/matchAgentsWithAttributeKey'
  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(update_match_agents_with_attribute_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ConfigClient#update_match_agents_with_attribute_key') 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::MatchAgentsWithAttributeKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_span_filter_pattern(apm_domain_id, validate_span_filter_pattern_details, opts = {}) ⇒ Response

Note:

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.

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

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/oci/apm_config/config_client.rb', line 1475

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.make_retrying_call(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