Class: OCI::ApmTraces::AttributesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_traces/attributes_client.rb

Overview

Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer. 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) ⇒ AttributesClient

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

  if endpoint
    @endpoint = endpoint + '/20200630'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "AttributesClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 29

def region
  @region
end

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

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

Returns:



25
26
27
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#bulk_activate_attribute(apm_domain_id, bulk_activate_attribute_details, opts = {}) ⇒ Response

Note:

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

Activates a set of attributes for the given APM Domain. The API is not case-sensitive. Any duplicates present in the bulk activation request are deduplicated and only unique attributes are activated. A maximum number of 700 string attributes and 100 numeric attributes can be activated in an APM Domain subject to the available string and numeric slots. Once an attribute has been activated, it may take sometime for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are activated. Attributes that are activated are unpinned by default if they are pinned.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • bulk_activate_attribute_details (OCI::ApmTraces::Models::BulkActivateAttributeDetails) —

    Request body containing the details about the set of attributes to be activated.

  • 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 Oracle-assigned 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
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 123

def bulk_activate_attribute(apm_domain_id, bulk_activate_attribute_details, opts = {})
  logger.debug 'Calling operation AttributesClient#bulk_activate_attribute.' if logger

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

  path = '/attributes/actions/activateAttributes'
  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(bulk_activate_attribute_details)

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

#bulk_de_activate_attribute(apm_domain_id, bulk_de_activate_attribute_details, opts = {}) ⇒ Response

Note:

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

Deactivates a set of attributes for the given APM Domain. The API is case in-sensitive. Any duplicates present in the bulk deactivation request are deduplicated and only unique attributes are deactivated. A maximum number of 700 string attributes and 100 numeric attributes can be deactivated in an APM Domain subject to the available string and numeric slots. Out of box attributes (Trace and Span) cannot be deactivated, and will result in a processing error. Once an attribute has been deactivated, it may take sometime for it to disappear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk deactivation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are deactivated.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • bulk_de_activate_attribute_details (OCI::ApmTraces::Models::BulkDeActivateAttributeDetails) —

    Request body containing the details about the set of attributes to be deactivated.

  • 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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 191

def bulk_de_activate_attribute(apm_domain_id, bulk_de_activate_attribute_details, opts = {})
  logger.debug 'Calling operation AttributesClient#bulk_de_activate_attribute.' if logger

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

  path = '/attributes/actions/deActivateAttributes'
  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(bulk_de_activate_attribute_details)

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

#bulk_pin_attribute(apm_domain_id, bulk_pin_attribute_details, opts = {}) ⇒ Response

Note:

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

Pin a set of attributes in the APM Domain. Attributes that are marked pinned are not autoactivated by ingest. Attributes that are deactivated are pinned by default.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • bulk_pin_attribute_details (OCI::ApmTraces::Models::BulkPinAttributeDetails) —

    Request body containing the details about the set of attributes to be pinned.

  • 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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 253

def bulk_pin_attribute(apm_domain_id, bulk_pin_attribute_details, opts = {})
  logger.debug 'Calling operation AttributesClient#bulk_pin_attribute.' if logger

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

  path = '/attributes/actions/pinAttributes'
  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(bulk_pin_attribute_details)

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

#bulk_unpin_attribute(apm_domain_id, bulk_unpin_attribute_details, opts = {}) ⇒ Response

Note:

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

Unpin a set of attributes in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • bulk_unpin_attribute_details (OCI::ApmTraces::Models::BulkUnpinAttributeDetails) —

    Request body containing the details about the set of attributes to be unpinned.

  • 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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 314

def bulk_unpin_attribute(apm_domain_id, bulk_unpin_attribute_details, opts = {})
  logger.debug 'Calling operation AttributesClient#bulk_unpin_attribute.' if logger

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

  path = '/attributes/actions/unPinAttributes'
  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(bulk_unpin_attribute_details)

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

#bulk_update_attribute(apm_domain_id, bulk_update_attribute_details, opts = {}) ⇒ Response

Note:

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

Update a set of attribute properties in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • bulk_update_attribute_details (OCI::ApmTraces::Models::BulkUpdateAttributeDetails) —

    Request body containing the details about the set of attributes for which properties are 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

  • :opc_request_id (String) —

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

Returns:



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
408
409
410
411
412
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 375

def bulk_update_attribute(apm_domain_id, bulk_update_attribute_details, opts = {})
  logger.debug 'Calling operation AttributesClient#bulk_update_attribute.' if logger

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

  path = '/attributes/actions/updateAttributes'
  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(bulk_update_attribute_details)

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

#bulk_update_attribute_notes(apm_domain_id, bulk_update_attribute_notes_details, opts = {}) ⇒ Response

Note:

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

Add or edit notes to a set of attributes in the APM Domain. Notes can be added to either an active or an inactive attribute. The notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute is activated).

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • bulk_update_attribute_notes_details (OCI::ApmTraces::Models::BulkUpdateAttributeNotesDetails) —

    Request body containing the details about the set of attributes for which notes are 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

  • :opc_request_id (String) —

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

Returns:



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 438

def bulk_update_attribute_notes(apm_domain_id, bulk_update_attribute_notes_details, opts = {})
  logger.debug 'Calling operation AttributesClient#bulk_update_attribute_notes.' if logger

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

  path = '/attributes/actions/updateNotes'
  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(bulk_update_attribute_notes_details)

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

#get_status_auto_activate(apm_domain_id, data_key_type, opts = {}) ⇒ Response

Note:

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

Get autoactivation status for a private data key or public data key in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • data_key_type (String) —

    Data key type for which auto-activate needs to be turned on or off.

    Allowed values are: PRIVATE_DATA_KEY, PUBLIC_DATA_KEY

  • 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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 500

def get_status_auto_activate(apm_domain_id, data_key_type, opts = {})
  logger.debug 'Calling operation AttributesClient#get_status_auto_activate.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling get_status_auto_activate." if apm_domain_id.nil?
  raise "Missing the required parameter 'data_key_type' when calling get_status_auto_activate." if data_key_type.nil?
  unless %w[PRIVATE_DATA_KEY PUBLIC_DATA_KEY].include?(data_key_type)
    raise "Invalid value for 'data_key_type', must be one of PRIVATE_DATA_KEY, PUBLIC_DATA_KEY."
  end

  path = '/attributes/autoActivateStatus'
  operation_signing_strategy = :standard

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

  # 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: 'AttributesClient#get_status_auto_activate') 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::ApmTraces::Models::AutoActivateStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 94

def logger
  @api_client.config.logger
end

#put_toggle_auto_activate(apm_domain_id, is_auto_activate_on, data_key_type, opts = {}) ⇒ Response

Note:

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

Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • is_auto_activate_on (BOOLEAN) —

    Autoactivate toggle switch. Set to true to turn on auto-activate. Set to false to turn off auto-activate.

  • data_key_type (String) —

    Data key type for which auto-activate needs to be turned on or off.

    Allowed values are: PRIVATE_DATA_KEY, PUBLIC_DATA_KEY

  • 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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
 
# File 'lib/oci/apm_traces/attributes_client.rb', line 568

def put_toggle_auto_activate(apm_domain_id, is_auto_activate_on, data_key_type, opts = {})
  logger.debug 'Calling operation AttributesClient#put_toggle_auto_activate.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling put_toggle_auto_activate." if apm_domain_id.nil?
  raise "Missing the required parameter 'is_auto_activate_on' when calling put_toggle_auto_activate." if is_auto_activate_on.nil?
  raise "Missing the required parameter 'data_key_type' when calling put_toggle_auto_activate." if data_key_type.nil?
  unless %w[PRIVATE_DATA_KEY PUBLIC_DATA_KEY].include?(data_key_type)
    raise "Invalid value for 'data_key_type', must be one of PRIVATE_DATA_KEY, PUBLIC_DATA_KEY."
  end

  path = '/attributes/actions/autoActivate'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:isAutoActivateOn] = is_auto_activate_on
  query_params[:dataKeyType] = data_key_type

  # 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: 'AttributesClient#put_toggle_auto_activate') 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::ApmTraces::Models::AutoActivateToggleStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end