Class: OCI::LogAnalytics::LogAnalyticsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/log_analytics_client.rb

Overview

The LogAnalytics API for the LogAnalytics service.

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) ⇒ LogAnalyticsClient

Creates a new LogAnalyticsClient. 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



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

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 + '/20200601'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "LogAnalyticsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_clientOCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



13
14
15
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 13

def api_client
  @api_client
end

#endpointString (readonly)

Fully qualified endpoint URL

Returns:

  • (String)


17
18
19
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 17

def endpoint
  @endpoint
end

#regionString

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

Returns:

  • (String)


27
28
29
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 27

def region
  @region
end

#retry_configOCI::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



23
24
25
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 23

def retry_config
  @retry_config
end

Instance Method Details

#add_entity_association(namespace_name, log_analytics_entity_id, add_entity_association_details, opts = {}) ⇒ Response

Note:

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

Adds association between input source log analytics entity and one or more existing destination entities.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_entity_id (String)

    The log analytics entity OCID.

  • add_entity_association_details (OCI::LogAnalytics::Models::AddEntityAssociationDetails)

    This parameter specifies the destination entity OCIDs with which associations are to be created.

  • 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)

    The client request ID for tracing.

  • :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.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 125

def add_entity_association(namespace_name, log_analytics_entity_id, add_entity_association_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#add_entity_association.' if logger

  raise "Missing the required parameter 'namespace_name' when calling add_entity_association." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_entity_id' when calling add_entity_association." if log_analytics_entity_id.nil?
  raise "Missing the required parameter 'add_entity_association_details' when calling add_entity_association." if add_entity_association_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_entity_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_entity_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/addEntityAssociations'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEntityId}', log_analytics_entity_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(add_entity_association_details)

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

#add_source_event_types(namespace_name, source_name, add_event_type_details, opts = {}) ⇒ Response

Note:

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

Add one or more event types to a source. An event type and version can be enabled only on one source.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • source_name (String)

    The source name.

  • add_event_type_details (OCI::LogAnalytics::Models::EventTypeDetails)

    Details of event types to be added to the source. The specified event type string could be the fully qualified name or a prefix that matches the event type.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



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/log_analytics/log_analytics_client.rb', line 195

def add_source_event_types(namespace_name, source_name, add_event_type_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#add_source_event_types.' if logger

  raise "Missing the required parameter 'namespace_name' when calling add_source_event_types." if namespace_name.nil?
  raise "Missing the required parameter 'source_name' when calling add_source_event_types." if source_name.nil?
  raise "Missing the required parameter 'add_event_type_details' when calling add_source_event_types." if add_event_type_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'source_name' must not be blank" if OCI::Internal::Util.blank_string?(source_name)

  path = '/namespaces/{namespaceName}/sources/{sourceName}/actions/addEventTypes'.sub('{namespaceName}', namespace_name.to_s).sub('{sourceName}', source_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(add_event_type_details)

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

#append_lookup_data(namespace_name, lookup_name, append_lookup_file_body, opts = {}) ⇒ Response

Note:

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

Appends data to the lookup content. The csv file containing the content to be appended is passed in as binary data in the request.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • lookup_name (String)

    The name of the lookup to operate on.

  • append_lookup_file_body (String, IO)

    The file to append.

  • 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

  • :is_force (BOOLEAN)

    is force (default to false)

  • :char_encoding (String)

    The character encoding of the uploaded file. (default to UTF-8)

  • :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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 271

def append_lookup_data(namespace_name, lookup_name, append_lookup_file_body, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#append_lookup_data.' if logger

  raise "Missing the required parameter 'namespace_name' when calling append_lookup_data." if namespace_name.nil?
  raise "Missing the required parameter 'lookup_name' when calling append_lookup_data." if lookup_name.nil?
  raise "Missing the required parameter 'append_lookup_file_body' when calling append_lookup_data." if append_lookup_file_body.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'lookup_name' must not be blank" if OCI::Internal::Util.blank_string?(lookup_name)

  path = '/namespaces/{namespaceName}/lookups/{lookupName}/actions/appendData'.sub('{namespaceName}', namespace_name.to_s).sub('{lookupName}', lookup_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isForce] = opts[:is_force] if !opts[:is_force].nil?
  query_params[:charEncoding] = opts[:char_encoding] if opts[:char_encoding]

  # Header Params
  header_params = {}
  header_params[:accept] = '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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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(append_lookup_file_body)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LogAnalyticsClient#append_lookup_data') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#batch_get_basic_info(namespace_name, basic_details, is_include_deleted, opts = {}) ⇒ Response

Note:

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

Lists basic information about a specified set of labels in batch.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • basic_details (OCI::LogAnalytics::Models::LabelNames)

    List of label names to get information on

  • is_include_deleted (BOOLEAN)

    A flag specifying whether or not to include information on deleted labels.

  • 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

  • :limit (Integer)

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

  • :page (String)

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String)

    The sort order to use, either ascending (ASC) or descending (DESC).

    Allowed values are: ASC, DESC

  • :basic_label_sort_by (String)

    The attribute used to sort the returned labels (default to name) Allowed values are: name, priority

  • :opc_request_id (String)

    The client request ID for tracing.

Returns:



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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 344

def batch_get_basic_info(namespace_name, basic_details, is_include_deleted, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#batch_get_basic_info.' if logger

  raise "Missing the required parameter 'namespace_name' when calling batch_get_basic_info." if namespace_name.nil?
  raise "Missing the required parameter 'basic_details' when calling batch_get_basic_info." if basic_details.nil?
  raise "Missing the required parameter 'is_include_deleted' when calling batch_get_basic_info." if is_include_deleted.nil?

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:basic_label_sort_by] && !%w[name priority].include?(opts[:basic_label_sort_by])
    raise 'Invalid value for "basic_label_sort_by", must be one of name, priority.'
  end
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/labels/actions/basicInfo'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isIncludeDeleted] = is_include_deleted
  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[:basicLabelSortBy] = opts[:basic_label_sort_by] if opts[:basic_label_sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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(basic_details)

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

#cancel_query_work_request(namespace_name, work_request_id, opts = {}) ⇒ Response

Note:

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

Cancel/Remove query job work request.

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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 421

def cancel_query_work_request(namespace_name, work_request_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#cancel_query_work_request.' if logger

  raise "Missing the required parameter 'namespace_name' when calling cancel_query_work_request." if namespace_name.nil?
  raise "Missing the required parameter 'work_request_id' when calling cancel_query_work_request." if work_request_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/namespaces/{namespaceName}/queryWorkRequests/{workRequestId}'.sub('{namespaceName}', namespace_name.to_s).sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

#change_log_analytics_em_bridge_compartment(namespace_name, log_analytics_em_bridge_id, change_log_analytics_em_bridge_compartment_details, opts = {}) ⇒ Response

Note:

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

Update the compartment of the log analytics enterprise manager bridge with the given id.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_em_bridge_id (String)

    The log analytics enterprise manager bridge OCID.

  • change_log_analytics_em_bridge_compartment_details (OCI::LogAnalytics::Models::ChangeLogAnalyticsEmBridgeCompartmentDetails)

    Log analytics enterprise manager bridge compartment Id 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 493

def change_log_analytics_em_bridge_compartment(namespace_name, log_analytics_em_bridge_id, change_log_analytics_em_bridge_compartment_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#change_log_analytics_em_bridge_compartment.' if logger

  raise "Missing the required parameter 'namespace_name' when calling change_log_analytics_em_bridge_compartment." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_em_bridge_id' when calling change_log_analytics_em_bridge_compartment." if log_analytics_em_bridge_id.nil?
  raise "Missing the required parameter 'change_log_analytics_em_bridge_compartment_details' when calling change_log_analytics_em_bridge_compartment." if change_log_analytics_em_bridge_compartment_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_em_bridge_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_em_bridge_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}/actions/changeCompartment'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEmBridgeId}', log_analytics_em_bridge_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(change_log_analytics_em_bridge_compartment_details)

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

#change_log_analytics_entity_compartment(namespace_name, log_analytics_entity_id, change_log_analytics_entity_compartment_details, opts = {}) ⇒ Response

Note:

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

Update the compartment of the log analytics entity with the given id.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_entity_id (String)

    The log analytics entity OCID.

  • change_log_analytics_entity_compartment_details (OCI::LogAnalytics::Models::ChangeLogAnalyticsEntityCompartmentDetails)

    Log analytics entity compartment Id 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



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

def change_log_analytics_entity_compartment(namespace_name, log_analytics_entity_id, change_log_analytics_entity_compartment_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#change_log_analytics_entity_compartment.' if logger

  raise "Missing the required parameter 'namespace_name' when calling change_log_analytics_entity_compartment." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_entity_id' when calling change_log_analytics_entity_compartment." if log_analytics_entity_id.nil?
  raise "Missing the required parameter 'change_log_analytics_entity_compartment_details' when calling change_log_analytics_entity_compartment." if change_log_analytics_entity_compartment_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_entity_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_entity_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/changeCompartment'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEntityId}', log_analytics_entity_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(change_log_analytics_entity_compartment_details)

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

#change_log_analytics_log_group_compartment(namespace_name, log_analytics_log_group_id, change_log_analytics_log_group_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified log group to a different compartment.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_log_group_id (String)

    unique logAnalytics log group identifier

  • change_log_analytics_log_group_compartment_details (OCI::LogAnalytics::Models::ChangeLogAnalyticsLogGroupCompartmentDetails)

    The information 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



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
680
681
682
683
684
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 643

def change_log_analytics_log_group_compartment(namespace_name, log_analytics_log_group_id, change_log_analytics_log_group_compartment_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#change_log_analytics_log_group_compartment.' if logger

  raise "Missing the required parameter 'namespace_name' when calling change_log_analytics_log_group_compartment." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_log_group_id' when calling change_log_analytics_log_group_compartment." if log_analytics_log_group_id.nil?
  raise "Missing the required parameter 'change_log_analytics_log_group_compartment_details' when calling change_log_analytics_log_group_compartment." if change_log_analytics_log_group_compartment_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_log_group_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_log_group_id)

  path = '/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}/actions/changeCompartment'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsLogGroupId}', log_analytics_log_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(change_log_analytics_log_group_compartment_details)

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

#change_log_analytics_object_collection_rule_compartment(namespace_name, log_analytics_object_collection_rule_id, change_log_analytics_object_collection_rule_compartment_details, opts = {}) ⇒ Response

Note:

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

Move the rule from it's current compartment to the given compartment.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_object_collection_rule_id (String)

    The Logging Analytics Object Collection Rule OCID.

  • change_log_analytics_object_collection_rule_compartment_details (OCI::LogAnalytics::Models::ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails)

    The new compartment this Object Collection Rule will be moved to.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



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
749
750
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 711

def change_log_analytics_object_collection_rule_compartment(namespace_name, log_analytics_object_collection_rule_id, change_log_analytics_object_collection_rule_compartment_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#change_log_analytics_object_collection_rule_compartment.' if logger

  raise "Missing the required parameter 'namespace_name' when calling change_log_analytics_object_collection_rule_compartment." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_object_collection_rule_id' when calling change_log_analytics_object_collection_rule_compartment." if log_analytics_object_collection_rule_id.nil?
  raise "Missing the required parameter 'change_log_analytics_object_collection_rule_compartment_details' when calling change_log_analytics_object_collection_rule_compartment." if change_log_analytics_object_collection_rule_compartment_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_object_collection_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_object_collection_rule_id)

  path = '/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}/actions/changeCompartment'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsObjectCollectionRuleId}', log_analytics_object_collection_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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 = @api_client.object_to_http_body(change_log_analytics_object_collection_rule_compartment_details)

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

#change_scheduled_task_compartment(namespace_name, scheduled_task_id, change_scheduled_task_compartment_details, opts = {}) ⇒ Response

Note:

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

Move the scheduled task into a different compartment within the same tenancy.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • scheduled_task_id (String)

    Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

  • change_scheduled_task_compartment_details (OCI::LogAnalytics::Models::ChangeScheduledTaskCompartmentDetails)

    The destination compartment identifier.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



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
816
817
818
819
820
821
822
823
824
825
826
827
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 786

def change_scheduled_task_compartment(namespace_name, scheduled_task_id, change_scheduled_task_compartment_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#change_scheduled_task_compartment.' if logger

  raise "Missing the required parameter 'namespace_name' when calling change_scheduled_task_compartment." if namespace_name.nil?
  raise "Missing the required parameter 'scheduled_task_id' when calling change_scheduled_task_compartment." if scheduled_task_id.nil?
  raise "Missing the required parameter 'change_scheduled_task_compartment_details' when calling change_scheduled_task_compartment." if change_scheduled_task_compartment_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'scheduled_task_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_task_id)

  path = '/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/changeCompartment'.sub('{namespaceName}', namespace_name.to_s).sub('{scheduledTaskId}', scheduled_task_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(change_scheduled_task_compartment_details)

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

#clean(namespace_name, scheduled_task_id, opts = {}) ⇒ Response

Note:

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

Clean accumulated acceleration data stored for the accelerated saved search. The ScheduledTask taskType must be ACCELERATION.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • scheduled_task_id (String)

    Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

  • 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

  • :time_start (DateTime)

    Optional parameter to specify start of time range, in the format defined by RFC3339. Default value is beginning of time.

  • :time_end (DateTime)

    Optional parameter to specify end of time range, in the format defined by RFC3339. Default value is end of time.

  • :opc_request_id (String)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



863
864
865
866
867
868
869
870
871
872
873
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
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 863

def clean(namespace_name, scheduled_task_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#clean.' if logger

  raise "Missing the required parameter 'namespace_name' when calling clean." if namespace_name.nil?
  raise "Missing the required parameter 'scheduled_task_id' when calling clean." if scheduled_task_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'scheduled_task_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_task_id)

  path = '/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/clean'.sub('{namespaceName}', namespace_name.to_s).sub('{scheduledTaskId}', scheduled_task_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]

  # 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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # 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: 'LogAnalyticsClient#clean') 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

#create_log_analytics_em_bridge(namespace_name, create_log_analytics_em_bridge_details, opts = {}) ⇒ Response

Note:

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

Add configuration for enterprise manager bridge. Enterprise manager bridge is used to automatically add selected entities from enterprise manager cloud control. A corresponding OCI bridge configuration is required in enterprise manager.

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)

    The client request ID for tracing.

Returns:



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 930

def create_log_analytics_em_bridge(namespace_name, create_log_analytics_em_bridge_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#create_log_analytics_em_bridge.' if logger

  raise "Missing the required parameter 'namespace_name' when calling create_log_analytics_em_bridge." if namespace_name.nil?
  raise "Missing the required parameter 'create_log_analytics_em_bridge_details' when calling create_log_analytics_em_bridge." if create_log_analytics_em_bridge_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEmBridges'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(create_log_analytics_em_bridge_details)

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

#create_log_analytics_entity(namespace_name, create_log_analytics_entity_details, opts = {}) ⇒ Response

Note:

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

Create a new log analytics entity.

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)

    The client request ID for tracing.

Returns:



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
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 995

def create_log_analytics_entity(namespace_name, create_log_analytics_entity_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#create_log_analytics_entity.' if logger

  raise "Missing the required parameter 'namespace_name' when calling create_log_analytics_entity." if namespace_name.nil?
  raise "Missing the required parameter 'create_log_analytics_entity_details' when calling create_log_analytics_entity." if create_log_analytics_entity_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEntities'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(create_log_analytics_entity_details)

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

#create_log_analytics_entity_type(namespace_name, create_log_analytics_entity_type_details, opts = {}) ⇒ Response

Note:

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

Add custom log analytics entity type.

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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1060

def create_log_analytics_entity_type(namespace_name, create_log_analytics_entity_type_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#create_log_analytics_entity_type.' if logger

  raise "Missing the required parameter 'namespace_name' when calling create_log_analytics_entity_type." if namespace_name.nil?
  raise "Missing the required parameter 'create_log_analytics_entity_type_details' when calling create_log_analytics_entity_type." if create_log_analytics_entity_type_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEntityTypes'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(create_log_analytics_entity_type_details)

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

#create_log_analytics_log_group(namespace_name, create_log_analytics_log_group_details, opts = {}) ⇒ Response

Note:

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

Creates a new log group in the specified compartment with the input display name. You may also specify optional information such as description, defined tags, and free-form tags.

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)

    The client request ID for tracing.

Returns:



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1125

def create_log_analytics_log_group(namespace_name, create_log_analytics_log_group_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#create_log_analytics_log_group.' if logger

  raise "Missing the required parameter 'namespace_name' when calling create_log_analytics_log_group." if namespace_name.nil?
  raise "Missing the required parameter 'create_log_analytics_log_group_details' when calling create_log_analytics_log_group." if create_log_analytics_log_group_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsLogGroups'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(create_log_analytics_log_group_details)

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

#create_log_analytics_object_collection_rule(namespace_name, create_log_analytics_object_collection_rule_details, opts = {}) ⇒ Response

Note:

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

Creates a rule to collect logs from an object storage bucket.

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)

    The client request ID for tracing.

Returns:



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1184

def create_log_analytics_object_collection_rule(namespace_name, create_log_analytics_object_collection_rule_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#create_log_analytics_object_collection_rule.' if logger

  raise "Missing the required parameter 'namespace_name' when calling create_log_analytics_object_collection_rule." if namespace_name.nil?
  raise "Missing the required parameter 'create_log_analytics_object_collection_rule_details' when calling create_log_analytics_object_collection_rule." if create_log_analytics_object_collection_rule_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(create_log_analytics_object_collection_rule_details)

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

#create_scheduled_task(namespace_name, create_scheduled_task_details, opts = {}) ⇒ Response

Note:

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

Schedule a task as specified and return task info.

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)

    The client request ID for tracing.

  • :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.

Returns:



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1247

def create_scheduled_task(namespace_name, create_scheduled_task_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#create_scheduled_task.' if logger

  raise "Missing the required parameter 'namespace_name' when calling create_scheduled_task." if namespace_name.nil?
  raise "Missing the required parameter 'create_scheduled_task_details' when calling create_scheduled_task." if create_scheduled_task_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/scheduledTasks'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(create_scheduled_task_details)

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

#delete_associations(namespace_name, delete_log_analytics_association_details, opts = {}) ⇒ Response

Note:

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

Deletes the associations between the sources and entities specified.

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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1313

def delete_associations(namespace_name, delete_log_analytics_association_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_associations.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_associations." if namespace_name.nil?
  raise "Missing the required parameter 'delete_log_analytics_association_details' when calling delete_associations." if delete_log_analytics_association_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/associations/actions/delete'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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(delete_log_analytics_association_details)

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

#delete_field(namespace_name, field_name, opts = {}) ⇒ Response

Note:

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

Deletes field with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • field_name (String)

    The field name.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1384

def delete_field(namespace_name, field_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_field.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_field." if namespace_name.nil?
  raise "Missing the required parameter 'field_name' when calling delete_field." if field_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'field_name' must not be blank" if OCI::Internal::Util.blank_string?(field_name)

  path = '/namespaces/{namespaceName}/fields/{fieldName}'.sub('{namespaceName}', namespace_name.to_s).sub('{fieldName}', field_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'LogAnalyticsClient#delete_field') 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_label(namespace_name, label_name, opts = {}) ⇒ Response

Note:

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

Deletes label with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • label_name (String)

    The label name.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1457

def delete_label(namespace_name, label_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_label.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_label." if namespace_name.nil?
  raise "Missing the required parameter 'label_name' when calling delete_label." if label_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'label_name' must not be blank" if OCI::Internal::Util.blank_string?(label_name)

  path = '/namespaces/{namespaceName}/labels/{labelName}'.sub('{namespaceName}', namespace_name.to_s).sub('{labelName}', label_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'LogAnalyticsClient#delete_label') 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_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, opts = {}) ⇒ Response

Note:

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

Delete log analytics enterprise manager bridge with the given id.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_em_bridge_id (String)

    The log analytics enterprise manager bridge OCID.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1524

def delete_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_log_analytics_em_bridge.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_log_analytics_em_bridge." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_em_bridge_id' when calling delete_log_analytics_em_bridge." if log_analytics_em_bridge_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_em_bridge_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_em_bridge_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEmBridgeId}', log_analytics_em_bridge_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_log_analytics_em_bridge') 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_log_analytics_entity(namespace_name, log_analytics_entity_id, opts = {}) ⇒ Response

Note:

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

Delete log analytics entity with the given id.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_entity_id (String)

    The log analytics entity OCID.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1589

def delete_log_analytics_entity(namespace_name, log_analytics_entity_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_log_analytics_entity.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_log_analytics_entity." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_entity_id' when calling delete_log_analytics_entity." if log_analytics_entity_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_entity_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_entity_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEntityId}', log_analytics_entity_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_log_analytics_entity') 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_log_analytics_entity_type(namespace_name, entity_type_name, opts = {}) ⇒ Response

Note:

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

Delete log analytics entity type with the given name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • entity_type_name (String)

    Log analytics entity type name.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1654

def delete_log_analytics_entity_type(namespace_name, entity_type_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_log_analytics_entity_type.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_log_analytics_entity_type." if namespace_name.nil?
  raise "Missing the required parameter 'entity_type_name' when calling delete_log_analytics_entity_type." if entity_type_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'entity_type_name' must not be blank" if OCI::Internal::Util.blank_string?(entity_type_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEntityTypes/{entityTypeName}'.sub('{namespaceName}', namespace_name.to_s).sub('{entityTypeName}', entity_type_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_log_analytics_entity_type') 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_log_analytics_log_group(namespace_name, log_analytics_log_group_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified log group. The log group cannot be part of an active association or have an active upload.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_log_group_id (String)

    unique logAnalytics log group identifier

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1719

def delete_log_analytics_log_group(namespace_name, log_analytics_log_group_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_log_analytics_log_group.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_log_analytics_log_group." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_log_group_id' when calling delete_log_analytics_log_group." if log_analytics_log_group_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_log_group_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_log_group_id)

  path = '/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsLogGroupId}', log_analytics_log_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_log_analytics_log_group') 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_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, opts = {}) ⇒ Response

Note:

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

Deletes the configured object storage bucket based collection rule and stop the log collection. It will not delete the existing processed data associated with this bucket from logging analytics storage.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_object_collection_rule_id (String)

    The Logging Analytics Object Collection Rule OCID.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1785

def delete_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_log_analytics_object_collection_rule.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_log_analytics_object_collection_rule." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_object_collection_rule_id' when calling delete_log_analytics_object_collection_rule." if log_analytics_object_collection_rule_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_object_collection_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_object_collection_rule_id)

  path = '/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsObjectCollectionRuleId}', log_analytics_object_collection_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LogAnalyticsClient#delete_log_analytics_object_collection_rule') 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_lookup(namespace_name, lookup_name, opts = {}) ⇒ Response

Note:

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

Deletes lookup with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • lookup_name (String)

    The name of the lookup to operate on.

  • 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

  • :is_force (BOOLEAN)

    is force (default to false)

  • :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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1857

def delete_lookup(namespace_name, lookup_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_lookup.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_lookup." if namespace_name.nil?
  raise "Missing the required parameter 'lookup_name' when calling delete_lookup." if lookup_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'lookup_name' must not be blank" if OCI::Internal::Util.blank_string?(lookup_name)

  path = '/namespaces/{namespaceName}/lookups/{lookupName}'.sub('{namespaceName}', namespace_name.to_s).sub('{lookupName}', lookup_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isForce] = opts[:is_force] if !opts[:is_force].nil?

  # 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'LogAnalyticsClient#delete_lookup') 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_parser(namespace_name, parser_name, opts = {}) ⇒ Response

Note:

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

Deletes parser with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • parser_name (String)

    The parser name.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1931

def delete_parser(namespace_name, parser_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_parser.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_parser." if namespace_name.nil?
  raise "Missing the required parameter 'parser_name' when calling delete_parser." if parser_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'parser_name' must not be blank" if OCI::Internal::Util.blank_string?(parser_name)

  path = '/namespaces/{namespaceName}/parsers/{parserName}'.sub('{namespaceName}', namespace_name.to_s).sub('{parserName}', parser_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'LogAnalyticsClient#delete_parser') 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_scheduled_task(namespace_name, scheduled_task_id, opts = {}) ⇒ Response

Note:

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

Delete the scheduled task.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • scheduled_task_id (String)

    Unique scheduledTask id returned from task create. If invalid will lead to a 404 not found.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 1999

def delete_scheduled_task(namespace_name, scheduled_task_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_scheduled_task.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_scheduled_task." if namespace_name.nil?
  raise "Missing the required parameter 'scheduled_task_id' when calling delete_scheduled_task." if scheduled_task_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'scheduled_task_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduled_task_id)

  path = '/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}'.sub('{namespaceName}', namespace_name.to_s).sub('{scheduledTaskId}', scheduled_task_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LogAnalyticsClient#delete_scheduled_task') 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_source(namespace_name, source_name, opts = {}) ⇒ Response

Note:

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

Deletes source with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • source_name (String)

    The source name.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:

  • (Response)

    A Response object with data of type nil



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2070

def delete_source(namespace_name, source_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_source.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_source." if namespace_name.nil?
  raise "Missing the required parameter 'source_name' when calling delete_source." if source_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'source_name' must not be blank" if OCI::Internal::Util.blank_string?(source_name)

  path = '/namespaces/{namespaceName}/sources/{sourceName}'.sub('{namespaceName}', namespace_name.to_s).sub('{sourceName}', source_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  # 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: 'LogAnalyticsClient#delete_source') 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_upload(namespace_name, upload_reference, opts = {}) ⇒ Response

Note:

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

Deletes an Upload by its reference. It deletes all the logs in storage asscoiated with the upload and the corresponding upload metadata.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • upload_reference (String)

    Unique internal identifier to refer upload container.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2138

def delete_upload(namespace_name, upload_reference, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_upload.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_upload." if namespace_name.nil?
  raise "Missing the required parameter 'upload_reference' when calling delete_upload." if upload_reference.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'upload_reference' must not be blank" if OCI::Internal::Util.blank_string?(upload_reference)

  path = '/namespaces/{namespaceName}/uploads/{uploadReference}'.sub('{namespaceName}', namespace_name.to_s).sub('{uploadReference}', upload_reference.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_upload') 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_upload_file(namespace_name, upload_reference, file_reference, opts = {}) ⇒ Response

Note:

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

Deletes a specific log file inside an upload by upload file reference. It deletes all the logs from storage associated with the file and the corresponding metadata.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • upload_reference (String)

    Unique internal identifier to refer upload container.

  • file_reference (String)

    Unique internal identifier to refer upload 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_request_id (String)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2199

def delete_upload_file(namespace_name, upload_reference, file_reference, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_upload_file.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_upload_file." if namespace_name.nil?
  raise "Missing the required parameter 'upload_reference' when calling delete_upload_file." if upload_reference.nil?
  raise "Missing the required parameter 'file_reference' when calling delete_upload_file." if file_reference.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'upload_reference' must not be blank" if OCI::Internal::Util.blank_string?(upload_reference)
  raise "Parameter value for 'file_reference' must not be blank" if OCI::Internal::Util.blank_string?(file_reference)

  path = '/namespaces/{namespaceName}/uploads/{uploadReference}/files/{fileReference}'.sub('{namespaceName}', namespace_name.to_s).sub('{uploadReference}', upload_reference.to_s).sub('{fileReference}', file_reference.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_upload_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

#delete_upload_warning(namespace_name, upload_reference, warning_reference, opts = {}) ⇒ Response

Note:

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

Suppresses a specific warning inside an upload.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • upload_reference (String)

    Unique internal identifier to refer upload container.

  • warning_reference (String)

    Unique internal identifier to refer upload warning.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2260

def delete_upload_warning(namespace_name, upload_reference, warning_reference, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#delete_upload_warning.' if logger

  raise "Missing the required parameter 'namespace_name' when calling delete_upload_warning." if namespace_name.nil?
  raise "Missing the required parameter 'upload_reference' when calling delete_upload_warning." if upload_reference.nil?
  raise "Missing the required parameter 'warning_reference' when calling delete_upload_warning." if warning_reference.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'upload_reference' must not be blank" if OCI::Internal::Util.blank_string?(upload_reference)
  raise "Parameter value for 'warning_reference' must not be blank" if OCI::Internal::Util.blank_string?(warning_reference)

  path = '/namespaces/{namespaceName}/uploads/{uploadReference}/warnings/{warningReference}'.sub('{namespaceName}', namespace_name.to_s).sub('{uploadReference}', upload_reference.to_s).sub('{warningReference}', warning_reference.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#delete_upload_warning') 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

#disable_archiving(namespace_name, opts = {}) ⇒ Response

Note:

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

This API disables archiving.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:



2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2325

def disable_archiving(namespace_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#disable_archiving.' if logger

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

  path = '/namespaces/{namespaceName}/storage/actions/disableArchiving'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

#disable_auto_association(namespace_name, source_name, disable_auto_association_details, opts = {}) ⇒ Response

Note:

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

Disables auto association for a log source. In the future, this log source would not be automatically associated with any entity that becomes eligible for association. In addition, you may also optionally remove all existing associations for this log source.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • source_name (String)

    The source name.

  • disable_auto_association_details (OCI::LogAnalytics::Models::DisableAutoAssociationDetails)

    Details required to disable auto association for the log source.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2392

def disable_auto_association(namespace_name, source_name, disable_auto_association_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#disable_auto_association.' if logger

  raise "Missing the required parameter 'namespace_name' when calling disable_auto_association." if namespace_name.nil?
  raise "Missing the required parameter 'source_name' when calling disable_auto_association." if source_name.nil?
  raise "Missing the required parameter 'disable_auto_association_details' when calling disable_auto_association." if disable_auto_association_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'source_name' must not be blank" if OCI::Internal::Util.blank_string?(source_name)

  path = '/namespaces/{namespaceName}/sources/{sourceName}/actions/disableAutoAssociation'.sub('{namespaceName}', namespace_name.to_s).sub('{sourceName}', source_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(disable_auto_association_details)

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

#disable_source_event_types(namespace_name, source_name, disable_event_type_details, opts = {}) ⇒ Response

Note:

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

Disable one or more event types in a source.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • source_name (String)

    The source name.

  • disable_event_type_details (OCI::LogAnalytics::Models::EventTypeDetails)

    Details of event types to be disabled in the source.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2460

def disable_source_event_types(namespace_name, source_name, disable_event_type_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#disable_source_event_types.' if logger

  raise "Missing the required parameter 'namespace_name' when calling disable_source_event_types." if namespace_name.nil?
  raise "Missing the required parameter 'source_name' when calling disable_source_event_types." if source_name.nil?
  raise "Missing the required parameter 'disable_event_type_details' when calling disable_source_event_types." if disable_event_type_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'source_name' must not be blank" if OCI::Internal::Util.blank_string?(source_name)

  path = '/namespaces/{namespaceName}/sources/{sourceName}/actions/disableEventTypes'.sub('{namespaceName}', namespace_name.to_s).sub('{sourceName}', source_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(disable_event_type_details)

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

#enable_archiving(namespace_name, opts = {}) ⇒ Response

Note:

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

THis API enables archiving.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • 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)

    The client request ID for tracing.

  • :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.

Returns:



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2526

def enable_archiving(namespace_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#enable_archiving.' if logger

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

  path = '/namespaces/{namespaceName}/storage/actions/enableArchiving'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

#enable_auto_association(namespace_name, source_name, enable_auto_association_details, opts = {}) ⇒ Response

Note:

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

Enables auto association for a log source. This would initiate immediate association of the source to any eligible entities it is not already associated with, and would also ensure the log source gets associated with entities that are added or become eligible in the future.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • source_name (String)

    The source name.

  • enable_auto_association_details (OCI::LogAnalytics::Models::EnableAutoAssociationDetails)

    Details required to enable auto association for the log source.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2593

def enable_auto_association(namespace_name, source_name, enable_auto_association_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#enable_auto_association.' if logger

  raise "Missing the required parameter 'namespace_name' when calling enable_auto_association." if namespace_name.nil?
  raise "Missing the required parameter 'source_name' when calling enable_auto_association." if source_name.nil?
  raise "Missing the required parameter 'enable_auto_association_details' when calling enable_auto_association." if enable_auto_association_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'source_name' must not be blank" if OCI::Internal::Util.blank_string?(source_name)

  path = '/namespaces/{namespaceName}/sources/{sourceName}/actions/enableAutoAssociation'.sub('{namespaceName}', namespace_name.to_s).sub('{sourceName}', source_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(enable_auto_association_details)

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

#enable_source_event_types(namespace_name, source_name, enable_event_type_details, opts = {}) ⇒ Response

Note:

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

Enable one or more event types in a source. An event type and version can be enabled only in one source.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • source_name (String)

    The source name.

  • enable_event_type_details (OCI::LogAnalytics::Models::EventTypeDetails)

    Details of event types to be enabled in the source.

  • 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)

    The client request ID for tracing.

Returns:

  • (Response)

    A Response object with data of type nil



2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2661

def enable_source_event_types(namespace_name, source_name, enable_event_type_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#enable_source_event_types.' if logger

  raise "Missing the required parameter 'namespace_name' when calling enable_source_event_types." if namespace_name.nil?
  raise "Missing the required parameter 'source_name' when calling enable_source_event_types." if source_name.nil?
  raise "Missing the required parameter 'enable_event_type_details' when calling enable_source_event_types." if enable_event_type_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'source_name' must not be blank" if OCI::Internal::Util.blank_string?(source_name)

  path = '/namespaces/{namespaceName}/sources/{sourceName}/actions/enableEventTypes'.sub('{namespaceName}', namespace_name.to_s).sub('{sourceName}', source_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(enable_event_type_details)

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

#estimate_purge_data_size(namespace_name, estimate_purge_data_size_details, opts = {}) ⇒ Response

Note:

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

This API estimates the size of data to be purged based based on time interval, purge query etc.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • estimate_purge_data_size_details (OCI::LogAnalytics::Models::EstimatePurgeDataSizeDetails)

    This is the input to estimate the size of data to be purged.

  • 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)

    The client request ID for tracing.

  • :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.

  • :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.

Returns:



2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2734

def estimate_purge_data_size(namespace_name, estimate_purge_data_size_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#estimate_purge_data_size.' if logger

  raise "Missing the required parameter 'namespace_name' when calling estimate_purge_data_size." if namespace_name.nil?
  raise "Missing the required parameter 'estimate_purge_data_size_details' when calling estimate_purge_data_size." if estimate_purge_data_size_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/storage/actions/estimatePurgeDataSize'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(estimate_purge_data_size_details)

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

#estimate_recall_data_size(namespace_name, estimate_recall_data_size_details, opts = {}) ⇒ Response

Note:

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

This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • estimate_recall_data_size_details (OCI::LogAnalytics::Models::EstimateRecallDataSizeDetails)

    This is the input to estimate the size of data to be recalled.

  • 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)

    The client request ID for tracing.

Returns:



2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2795

def estimate_recall_data_size(namespace_name, estimate_recall_data_size_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#estimate_recall_data_size.' if logger

  raise "Missing the required parameter 'namespace_name' when calling estimate_recall_data_size." if namespace_name.nil?
  raise "Missing the required parameter 'estimate_recall_data_size_details' when calling estimate_recall_data_size." if estimate_recall_data_size_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/storage/actions/estimateRecallDataSize'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(estimate_recall_data_size_details)

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

#estimate_release_data_size(namespace_name, estimate_release_data_size_details, opts = {}) ⇒ Response

Note:

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

This API gives an active storage usage estimate for recalled data to be released and the time range of such data.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • estimate_release_data_size_details (OCI::LogAnalytics::Models::EstimateReleaseDataSizeDetails)

    This is the input to estimate the size of recalled data to be released.

  • 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)

    The client request ID for tracing.

Returns:



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2853

def estimate_release_data_size(namespace_name, estimate_release_data_size_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#estimate_release_data_size.' if logger

  raise "Missing the required parameter 'namespace_name' when calling estimate_release_data_size." if namespace_name.nil?
  raise "Missing the required parameter 'estimate_release_data_size_details' when calling estimate_release_data_size." if estimate_release_data_size_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/storage/actions/estimateReleaseDataSize'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(estimate_release_data_size_details)

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

#export_custom_content(namespace_name, export_custom_content_details, opts = {}, &block) ⇒ Response

Note:

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

Exports all custom details of the specified sources, parsers, fields and labels, in zip format.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • export_custom_content_details (OCI::LogAnalytics::Models::ExportContent)

    content to export

  • 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_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



2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 2919

def export_custom_content(namespace_name, export_custom_content_details, opts = {}, &block)
  logger.debug 'Calling operation LogAnalyticsClient#export_custom_content.' if logger

  raise "Missing the required parameter 'namespace_name' when calling export_custom_content." if namespace_name.nil?
  raise "Missing the required parameter 'export_custom_content_details' when calling export_custom_content." if export_custom_content_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/contents/actions/exportCustomContent'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  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-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_custom_content_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LogAnalyticsClient#export_custom_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: '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(
            :POST,
            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(
        :POST,
        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

#export_query_result(namespace_name, export_details, opts = {}, &block) ⇒ Response

Note:

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

Export data based on query. Endpoint returns a stream of data. Endpoint is synchronous. Queries must deliver first result within 60 seconds or calls are subject to timeout.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • export_details (OCI::LogAnalytics::Models::ExportDetails)

    Query to be exported

  • 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_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



3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3024

def export_query_result(namespace_name, export_details, opts = {}, &block)
  logger.debug 'Calling operation LogAnalyticsClient#export_query_result.' if logger

  raise "Missing the required parameter 'namespace_name' when calling export_query_result." if namespace_name.nil?
  raise "Missing the required parameter 'export_details' when calling export_query_result." if export_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/search/actions/export'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/octet-stream'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(export_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LogAnalyticsClient#export_query_result') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: '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(
            :POST,
            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(
        :POST,
        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

#extract_structured_log_field_paths(namespace_name, logan_parser_details, opts = {}) ⇒ Response

Note:

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

Extracts the field paths from the example json or xml content.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • logan_parser_details (OCI::LogAnalytics::Models::LogAnalyticsParser)

    parser definition

  • 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

  • :parser_type (String)

    The parser type - possible values are XML or JSON. (default to JSON) Allowed values are: XML, JSON

  • :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)

    The client request ID for tracing.

Returns:



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3134

def extract_structured_log_field_paths(namespace_name, logan_parser_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#extract_structured_log_field_paths.' if logger

  raise "Missing the required parameter 'namespace_name' when calling extract_structured_log_field_paths." if namespace_name.nil?
  raise "Missing the required parameter 'logan_parser_details' when calling extract_structured_log_field_paths." if logan_parser_details.nil?

  if opts[:parser_type] && !%w[XML JSON].include?(opts[:parser_type])
    raise 'Invalid value for "parser_type", must be one of XML, JSON.'
  end
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/parsers/actions/extractLogFieldPaths'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:parserType] = opts[:parser_type] if opts[:parser_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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(logan_parser_details)

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

#extract_structured_log_header_paths(namespace_name, logan_parser_details, opts = {}) ⇒ Response

Note:

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

Extracts the header paths from the example json or xml content.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • logan_parser_details (OCI::LogAnalytics::Models::LogAnalyticsParser)

    parser definition

  • 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

  • :parser_type (String)

    The parser type - possible values are XML or JSON. (default to JSON) Allowed values are: XML, JSON

  • :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)

    The client request ID for tracing.

Returns:



3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3207

def extract_structured_log_header_paths(namespace_name, logan_parser_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#extract_structured_log_header_paths.' if logger

  raise "Missing the required parameter 'namespace_name' when calling extract_structured_log_header_paths." if namespace_name.nil?
  raise "Missing the required parameter 'logan_parser_details' when calling extract_structured_log_header_paths." if logan_parser_details.nil?

  if opts[:parser_type] && !%w[XML JSON].include?(opts[:parser_type])
    raise 'Invalid value for "parser_type", must be one of XML, JSON.'
  end
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/parsers/actions/extractLogHeaderPaths'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:parserType] = opts[:parser_type] if opts[:parser_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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(logan_parser_details)

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

#filter(namespace_name, filter_details, opts = {}) ⇒ Response

Note:

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

Each filter specifies an operator, a field and one or more values to be inserted into the provided query as criteria.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • filter_details (OCI::LogAnalytics::Models::FilterDetails)

    Query string and filters to add or remove

  • 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)

    The client request ID for tracing.

Returns:



3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3271

def filter(namespace_name, filter_details, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#filter.' if logger

  raise "Missing the required parameter 'namespace_name' when calling filter." if namespace_name.nil?
  raise "Missing the required parameter 'filter_details' when calling filter." if filter_details.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/search/actions/filter'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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(filter_details)

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

#get_association_summary(namespace_name, compartment_id, opts = {}) ⇒ Response

Note:

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

Returns the count of source associations for entities in the specified compartment.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • compartment_id (String)

    The ID of the compartment in which to list resources.

  • 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)

    The client request ID for tracing.

Returns:



3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3329

def get_association_summary(namespace_name, compartment_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_association_summary.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_association_summary." if namespace_name.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_association_summary." if compartment_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/associationSummary'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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: 'LogAnalyticsClient#get_association_summary') 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::LogAnalytics::Models::AssociationSummaryReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_column_names(namespace_name, sql_query, opts = {}) ⇒ Response

Note:

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

Extracts column names from the input SQL query.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • sql_query (String)

    The SQL query from which column names are to be extracted.

  • 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)

    The client request ID for tracing.

Returns:



3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3394

def get_column_names(namespace_name, sql_query, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_column_names.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_column_names." if namespace_name.nil?
  raise "Missing the required parameter 'sql_query' when calling get_column_names." if sql_query.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/sources/sqlColumnNames'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sqlQuery] = sql_query

  # 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 = nil

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

#get_config_work_request(namespace_name, work_request_id, opts = {}) ⇒ Response

Note:

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

Returns detailed information about the configuration work request with the specified id.

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)

    The client request ID for tracing.

Returns:



3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3455

def get_config_work_request(namespace_name, work_request_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_config_work_request.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_config_work_request." if namespace_name.nil?
  raise "Missing the required parameter 'work_request_id' when calling get_config_work_request." if work_request_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/namespaces/{namespaceName}/configWorkRequests/{workRequestId}'.sub('{namespaceName}', namespace_name.to_s).sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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: 'LogAnalyticsClient#get_config_work_request') 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::LogAnalytics::Models::LogAnalyticsConfigWorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_field(namespace_name, field_name, opts = {}) ⇒ Response

Note:

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

Gets detailed information about the field with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • field_name (String)

    The field name.

  • 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)

    The client request ID for tracing.

Returns:



3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3514

def get_field(namespace_name, field_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_field.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_field." if namespace_name.nil?
  raise "Missing the required parameter 'field_name' when calling get_field." if field_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'field_name' must not be blank" if OCI::Internal::Util.blank_string?(field_name)

  path = '/namespaces/{namespaceName}/fields/{fieldName}'.sub('{namespaceName}', namespace_name.to_s).sub('{fieldName}', field_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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: 'LogAnalyticsClient#get_field') 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::LogAnalytics::Models::LogAnalyticsField'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fields_summary(namespace_name, opts = {}) ⇒ Response

Note:

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

Returns the count of fields. You may optionally specify isShowDetail=true to view a summary of each field data type.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • 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

  • :is_show_detail (BOOLEAN)

    A boolean indicating whether or not to display detailed field summary information (default to false)

  • :opc_request_id (String)

    The client request ID for tracing.

Returns:



3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3574

def get_fields_summary(namespace_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_fields_summary.' if logger

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

  path = '/namespaces/{namespaceName}/fieldSummary'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:isShowDetail] = opts[:is_show_detail] if !opts[:is_show_detail].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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: 'LogAnalyticsClient#get_fields_summary') 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::LogAnalytics::Models::FieldSummaryReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_label(namespace_name, label_name, opts = {}) ⇒ Response

Note:

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

Gets detailed information about the label with the specified name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • label_name (String)

    The label name.

  • 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)

    The client request ID for tracing.

Returns:



3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3632

def get_label(namespace_name, label_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_label.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_label." if namespace_name.nil?
  raise "Missing the required parameter 'label_name' when calling get_label." if label_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'label_name' must not be blank" if OCI::Internal::Util.blank_string?(label_name)

  path = '/namespaces/{namespaceName}/labels/{labelName}'.sub('{namespaceName}', namespace_name.to_s).sub('{labelName}', label_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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: 'LogAnalyticsClient#get_label') 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::LogAnalytics::Models::LogAnalyticsLabel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_label_summary(namespace_name, opts = {}) ⇒ Response

Note:

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

Returns the count of labels.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • 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)

    The client request ID for tracing.

Returns:



3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3690

def get_label_summary(namespace_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_label_summary.' if logger

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

  path = '/namespaces/{namespaceName}/labelSummary'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json;charset=UTF-8'
  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: 'LogAnalyticsClient#get_label_summary') 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::LogAnalytics::Models::LabelSummaryReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, opts = {}) ⇒ Response

Note:

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

Retrieve the log analytics enterprise manager bridge with the given id.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_em_bridge_id (String)

    The log analytics enterprise manager bridge OCID.

  • 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)

    The client request ID for tracing.

Returns:



3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3747

def get_log_analytics_em_bridge(namespace_name, log_analytics_em_bridge_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_em_bridge.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_em_bridge." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_em_bridge_id' when calling get_log_analytics_em_bridge." if log_analytics_em_bridge_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_em_bridge_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_em_bridge_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEmBridgeId}', log_analytics_em_bridge_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#get_log_analytics_em_bridge') 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::LogAnalytics::Models::LogAnalyticsEmBridge'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_em_bridge_summary(namespace_name, compartment_id, opts = {}) ⇒ Response

Note:

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

Returns log analytics enterprise manager bridges summary report.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • compartment_id (String)

    The ID of the compartment in which to list resources.

  • 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)

    The client request ID for tracing.

Returns:



3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3805

def get_log_analytics_em_bridge_summary(namespace_name, compartment_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_em_bridge_summary.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_em_bridge_summary." if namespace_name.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_log_analytics_em_bridge_summary." if compartment_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEmBridges/emBridgeSummary'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_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: 'LogAnalyticsClient#get_log_analytics_em_bridge_summary') 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::LogAnalytics::Models::LogAnalyticsEmBridgeSummaryReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_entities_summary(namespace_name, compartment_id, opts = {}) ⇒ Response

Note:

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

Returns log analytics entities count summary report.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • compartment_id (String)

    The ID of the compartment in which to list resources.

  • 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)

    The client request ID for tracing.

Returns:



3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3863

def get_log_analytics_entities_summary(namespace_name, compartment_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_entities_summary.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_entities_summary." if namespace_name.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_log_analytics_entities_summary." if compartment_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEntities/entitySummary'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_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: 'LogAnalyticsClient#get_log_analytics_entities_summary') 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::LogAnalytics::Models::LogAnalyticsEntitySummaryReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_entity(namespace_name, log_analytics_entity_id, opts = {}) ⇒ Response

Note:

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

Retrieve the log analytics entity with the given id.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_entity_id (String)

    The log analytics entity OCID.

  • 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)

    The client request ID for tracing.

Returns:



3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3922

def get_log_analytics_entity(namespace_name, log_analytics_entity_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_entity.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_entity." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_entity_id' when calling get_log_analytics_entity." if log_analytics_entity_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_entity_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_entity_id)

  path = '/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsEntityId}', log_analytics_entity_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#get_log_analytics_entity') 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::LogAnalytics::Models::LogAnalyticsEntity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_entity_type(namespace_name, entity_type_name, opts = {}) ⇒ Response

Note:

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

Retrieve the log analytics entity type with the given name.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • entity_type_name (String)

    Log analytics entity type name.

  • 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)

    The client request ID for tracing.

Returns:



3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 3981

def get_log_analytics_entity_type(namespace_name, entity_type_name, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_entity_type.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_entity_type." if namespace_name.nil?
  raise "Missing the required parameter 'entity_type_name' when calling get_log_analytics_entity_type." if entity_type_name.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'entity_type_name' must not be blank" if OCI::Internal::Util.blank_string?(entity_type_name)

  path = '/namespaces/{namespaceName}/logAnalyticsEntityTypes/{entityTypeName}'.sub('{namespaceName}', namespace_name.to_s).sub('{entityTypeName}', entity_type_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#get_log_analytics_entity_type') 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::LogAnalytics::Models::LogAnalyticsEntityType'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_log_group(namespace_name, log_analytics_log_group_id, opts = {}) ⇒ Response

Note:

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

Gets detailed information about the specified log group such as display name, description, defined tags, and free-form tags.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_log_group_id (String)

    unique logAnalytics log group identifier

  • 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)

    The client request ID for tracing.

Returns:



4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 4040

def get_log_analytics_log_group(namespace_name, log_analytics_log_group_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_log_group.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_log_group." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_log_group_id' when calling get_log_analytics_log_group." if log_analytics_log_group_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_log_group_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_log_group_id)

  path = '/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsLogGroupId}', log_analytics_log_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#get_log_analytics_log_group') 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::LogAnalytics::Models::LogAnalyticsLogGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_log_groups_summary(namespace_name, compartment_id, opts = {}) ⇒ Response

Note:

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

Returns the count of log groups in a compartment.

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • compartment_id (String)

    The ID of the compartment in which to list resources.

  • 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)

    The client request ID for tracing.

Returns:



4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 4099

def get_log_analytics_log_groups_summary(namespace_name, compartment_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_log_groups_summary.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_log_groups_summary." if namespace_name.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_log_analytics_log_groups_summary." if compartment_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)

  path = '/namespaces/{namespaceName}/logAnalyticsLogGroupsSummary'.sub('{namespaceName}', namespace_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_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: 'LogAnalyticsClient#get_log_analytics_log_groups_summary') 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::LogAnalytics::Models::LogGroupSummaryReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, opts = {}) ⇒ Response

Note:

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

Gets a configured object storage based collection rule by given id

Parameters:

  • namespace_name (String)

    The Logging Analytics namespace used for the request.

  • log_analytics_object_collection_rule_id (String)

    The Logging Analytics Object Collection Rule OCID.

  • 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)

    The client request ID for tracing.

Returns:



4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
# File 'lib/oci/log_analytics/log_analytics_client.rb', line 4157

def get_log_analytics_object_collection_rule(namespace_name, log_analytics_object_collection_rule_id, opts = {})
  logger.debug 'Calling operation LogAnalyticsClient#get_log_analytics_object_collection_rule.' if logger

  raise "Missing the required parameter 'namespace_name' when calling get_log_analytics_object_collection_rule." if namespace_name.nil?
  raise "Missing the required parameter 'log_analytics_object_collection_rule_id' when calling get_log_analytics_object_collection_rule." if log_analytics_object_collection_rule_id.nil?
  raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
  raise "Parameter value for 'log_analytics_object_collection_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(log_analytics_object_collection_rule_id)

  path = '/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}'.sub('{namespaceName}', namespace_name.to_s).sub('{logAnalyticsObjectCollectionRuleId}', log_analytics_object_collection_rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LogAnalyticsClient#get_log_analytics_object_collection_rule