Class: OCI::OsManagement::EventClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management/event_client.rb

Overview

API for the OS Management service. Use these API operations for working with Managed instances and Managed instance groups.

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

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/os_management/event_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/os_management/event_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/os_management/event_client.rb', line 30

def region
  @region
end

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

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

Returns:



26
27
28
 
# File 'lib/oci/os_management/event_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#delete_event_content(managed_instance_id, event_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Delete an event content ZIP archive from the service

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • event_id (String) —

    Unique Event identifier (OCID)

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
167
168
169
 
# File 'lib/oci/os_management/event_client.rb', line 127

def delete_event_content(managed_instance_id, event_id, compartment_id, opts = {})
  logger.debug 'Calling operation EventClient#delete_event_content.' if logger

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

  path = '/managedInstances/{managedInstanceId}/events/{eventId}/content'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{eventId}', event_id.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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # 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: 'EventClient#delete_event_content') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_event(managed_instance_id, event_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Gets an Event by identifier

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • event_id (String) —

    Unique Event identifier (OCID)

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



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

def get_event(managed_instance_id, event_id, compartment_id, opts = {})
  logger.debug 'Calling operation EventClient#get_event.' if logger

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

  path = '/managedInstances/{managedInstanceId}/events/{eventId}'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{eventId}', event_id.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: 'EventClient#get_event') 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::OsManagement::Models::Event'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_event_content(managed_instance_id, event_id, compartment_id, opts = {}, &block) ⇒ Response

Note:

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

Get additional data about a event as a ZIP archive. The archive content depends on the event eventType.

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • event_id (String) —

    Unique Event identifier (OCID)

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

  • 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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/os_management/event_client.rb', line 252

def get_event_content(managed_instance_id, event_id, compartment_id, opts = {}, &block)
  logger.debug 'Calling operation EventClient#get_event_content.' if logger

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

  path = '/managedInstances/{managedInstanceId}/events/{eventId}/content'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{eventId}', event_id.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] = 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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'EventClient#get_event_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_event_report(managed_instance_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Get summary information about events on this instance.

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • 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

  • :latest_timestamp_less_than (DateTime) —

    filter event occurrence. Selecting only those last occurred before given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z

  • :latest_timestamp_greater_than_or_equal_to (DateTime) —

    filter event occurrence. Selecting only those last occurred on or after given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/oci/os_management/event_client.rb', line 362

def get_event_report(managed_instance_id, compartment_id, opts = {})
  logger.debug 'Calling operation EventClient#get_event_report.' if logger

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

  path = '/managedInstances/{managedInstanceId}/events/report'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:latestTimestampLessThan] = opts[:latest_timestamp_less_than] if opts[:latest_timestamp_less_than]
  query_params[:latestTimestampGreaterThanOrEqualTo] = opts[:latest_timestamp_greater_than_or_equal_to] if opts[:latest_timestamp_greater_than_or_equal_to]

  # 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: 'EventClient#get_event_report') 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::OsManagement::Models::EventReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_events(managed_instance_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Events.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • 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

  • :event_id (String) —

    Unique event identifier (OCID)

  • :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 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default. (default to TIMECREATED)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :event_type (String) —

    A filter to return only event of given type.

  • :latest_timestamp_less_than (DateTime) —

    filter event occurrence. Selecting only those last occurred before given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z

  • :latest_timestamp_greater_than_or_equal_to (DateTime) —

    filter event occurrence. Selecting only those last occurred on or after given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z

Returns:



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/oci/os_management/event_client.rb', line 437

def list_events(managed_instance_id, compartment_id, opts = {})
  logger.debug 'Calling operation EventClient#list_events.' if logger

  raise "Missing the required parameter 'managed_instance_id' when calling list_events." if managed_instance_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_events." if compartment_id.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[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:event_type] && !OCI::OsManagement::Models::EVENT_TYPE_ENUM.include?(opts[:event_type])
    raise 'Invalid value for "event_type", must be one of the values in OCI::OsManagement::Models::EVENT_TYPE_ENUM.'
  end
  raise "Parameter value for 'managed_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(managed_instance_id)

  path = '/managedInstances/{managedInstanceId}/events'.sub('{managedInstanceId}', managed_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:eventId] = opts[:event_id] if opts[:event_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:eventType] = opts[:event_type] if opts[:event_type]
  query_params[:latestTimestampLessThan] = opts[:latest_timestamp_less_than] if opts[:latest_timestamp_less_than]
  query_params[:latestTimestampGreaterThanOrEqualTo] = opts[:latest_timestamp_greater_than_or_equal_to] if opts[:latest_timestamp_greater_than_or_equal_to]

  # 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: 'EventClient#list_events') 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::OsManagement::Models::EventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_related_events(event_fingerprint, compartment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of related events. For now pagination is not implemented.

Allowed values are: instanceId, id, eventFingerprint

Parameters:

  • event_fingerprint (String) —

    Event fingerprint identifier

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

  • :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 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for id is descending. (default to instanceId)

  • :latest_timestamp_less_than (DateTime) —

    filter event occurrence. Selecting only those last occurred before given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z

  • :latest_timestamp_greater_than_or_equal_to (DateTime) —

    filter event occurrence. Selecting only those last occurred on or after given date in ISO 8601 format Example: 2017-07-14T02:40:00.000Z

Returns:



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/oci/os_management/event_client.rb', line 528

def list_related_events(event_fingerprint, compartment_id, opts = {})
  logger.debug 'Calling operation EventClient#list_related_events.' if logger

  raise "Missing the required parameter 'event_fingerprint' when calling list_related_events." if event_fingerprint.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_related_events." if compartment_id.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[:sort_by] && !%w[instanceId id eventFingerprint].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of instanceId, id, eventFingerprint.'
  end

  path = '/relatedEvents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:eventFingerprint] = event_fingerprint
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:latestTimestampLessThan] = opts[:latest_timestamp_less_than] if opts[:latest_timestamp_less_than]
  query_params[:latestTimestampGreaterThanOrEqualTo] = opts[:latest_timestamp_greater_than_or_equal_to] if opts[:latest_timestamp_greater_than_or_equal_to]

  # 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: 'EventClient#list_related_events') 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::OsManagement::Models::RelatedEventCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



95
96
97
 
# File 'lib/oci/os_management/event_client.rb', line 95

def logger
  @api_client.config.logger
end

#update_event(managed_instance_id, event_id, compartment_id, update_event_details, opts = {}) ⇒ Response

Note:

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

Updates an existing event associated to a managed instance

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • event_id (String) —

    Unique Event identifier (OCID)

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

  • update_event_details (OCI::OsManagement::Models::UpdateEventDetails) —

    Details about the event to update

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



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/oci/os_management/event_client.rb', line 607

def update_event(managed_instance_id, event_id, compartment_id, update_event_details, opts = {})
  logger.debug 'Calling operation EventClient#update_event.' if logger

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

  path = '/managedInstances/{managedInstanceId}/events/{eventId}'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{eventId}', event_id.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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_event_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'EventClient#update_event') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::OsManagement::Models::Event'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upload_event_content(managed_instance_id, event_id, compartment_id, opts = {}) ⇒ Response

Note:

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

Upload the event content as a ZIP archive from the managed instance to the service

Parameters:

  • managed_instance_id (String) —

    Instance Oracle Cloud identifier (ocid)

  • event_id (String) —

    Unique Event identifier (OCID)

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

  • :if_match (String) —

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

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/oci/os_management/event_client.rb', line 682

def upload_event_content(managed_instance_id, event_id, compartment_id, opts = {})
  logger.debug 'Calling operation EventClient#upload_event_content.' if logger

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

  path = '/managedInstances/{managedInstanceId}/events/{eventId}/content/actions/upload'.sub('{managedInstanceId}', managed_instance_id.to_s).sub('{eventId}', event_id.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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # 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: 'EventClient#upload_event_content') 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