Class: OCI::Queue::QueueClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/queue/queue_client.rb

Overview

Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see Queue.

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

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/queue/queue_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/queue/queue_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/queue/queue_client.rb', line 29

def region
  @region
end

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

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

Returns:



25
26
27
 
# File 'lib/oci/queue/queue_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#delete_message(queue_id, message_receipt, opts = {}) ⇒ Response

Note:

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

Deletes the message represented by the receipt from the queue. You must use the messages endpoint to delete messages. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint.

Parameters:

  • queue_id (String) —

    The unique queue identifier.

  • message_receipt (String) —

    The receipt of the message retrieved from a GetMessages call.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/queue/queue_client.rb', line 115

def delete_message(queue_id, message_receipt, opts = {})
  logger.debug 'Calling operation QueueClient#delete_message.' if logger

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

  path = '/queues/{queueId}/messages/{messageReceipt}'.sub('{queueId}', queue_id.to_s).sub('{messageReceipt}', message_receipt.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: 'QueueClient#delete_message') 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_messages(queue_id, delete_messages_details, opts = {}) ⇒ Response

Note:

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

Deletes multiple messages from the queue. You must use the messages endpoint to delete messages. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint.

Parameters:

  • queue_id (String) —

    The unique queue identifier.

  • delete_messages_details (OCI::Queue::Models::DeleteMessagesDetails) —

    Details for the messages to delete.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

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

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/queue/queue_client.rb', line 174

def delete_messages(queue_id, delete_messages_details, opts = {})
  logger.debug 'Calling operation QueueClient#delete_messages.' if logger

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

  path = '/queues/{queueId}/messages/actions/deleteMessages'.sub('{queueId}', queue_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 = @api_client.object_to_http_body(delete_messages_details)

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

#get_messages(queue_id, opts = {}) ⇒ Response

Note:

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

Consumes messages from the queue. You must use the messages endpoint to consume messages. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint. GetMessages accepts optional channelFilter query parameter that can filter source channels of the messages. When channelFilter is present, service will return available messages from the channel which ID exactly matched the filter. When filter is not specified, messages will be returned from a random non-empty channel within a queue.

Parameters:

  • queue_id (String) —

    The unique queue 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

  • :visibility_in_seconds (Integer) —

    If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won't be consumable by other consumers during that time. If it isn't set it defaults to the value set at the queue level.

    Using a visibilityInSeconds value of 0 effectively acts as a peek functionality. Messages retrieved that way aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one.

  • :timeout_in_seconds (Integer) —

    If the timeoutInSeconds parameter isn't set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after timeoutInSeconds seconds (in which case it will return an empty response), whichever comes first.

    If the parameter is set to 0, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not. In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout. (default to 30)

  • :limit (Integer) —

    The limit parameter controls how many messages is returned at-most. (default to 1)

  • :opc_request_id (String) —

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

  • :channel_filter (String) —

    Optional parameter to filter the channels.

Returns:



249
250
251
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
 
# File 'lib/oci/queue/queue_client.rb', line 249

def get_messages(queue_id, opts = {})
  logger.debug 'Calling operation QueueClient#get_messages.' if logger

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

  path = '/queues/{queueId}/messages'.sub('{queueId}', queue_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:visibilityInSeconds] = opts[:visibility_in_seconds] if opts[:visibility_in_seconds]
  query_params[:timeoutInSeconds] = opts[:timeout_in_seconds] if opts[:timeout_in_seconds]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:channelFilter] = opts[:channel_filter] if opts[:channel_filter]

  # 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: 'QueueClient#get_messages') 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::Queue::Models::GetMessages'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_stats(queue_id, opts = {}) ⇒ Response

Note:

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

Gets the statistics for the queue and its dead letter queue. You must use the messages endpoint to get a queue's statistics. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint.

Parameters:

  • queue_id (String) —

    The unique queue 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) —

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

  • :channel_id (String) —

    Id to specify channel.

Returns:



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
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/queue/queue_client.rb', line 311

def get_stats(queue_id, opts = {})
  logger.debug 'Calling operation QueueClient#get_stats.' if logger

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

  path = '/queues/{queueId}/stats'.sub('{queueId}', queue_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:channelId] = opts[:channel_id] if opts[:channel_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: 'QueueClient#get_stats') 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::Queue::Models::QueueStats'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_channels(queue_id, opts = {}) ⇒ Response

Note:

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

Gets the list of IDs of non-empty channels. It will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics. API supports optional channelFilter parameter which will filter the returned results according to the specified filter. List of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated.

Parameters:

  • queue_id (String) —

    The unique queue 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) —

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

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :channel_filter (String) —

    Optional parameter to filter the channels.

Returns:



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/queue/queue_client.rb', line 373

def list_channels(queue_id, opts = {})
  logger.debug 'Calling operation QueueClient#list_channels.' if logger

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

  path = '/queues/{queueId}/channels'.sub('{queueId}', queue_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:channelFilter] = opts[:channel_filter] if opts[:channel_filter]

  # 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: 'QueueClient#list_channels') 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::Queue::Models::ChannelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/queue/queue_client.rb', line 94

def logger
  @api_client.config.logger
end

#put_messages(queue_id, put_messages_details, opts = {}) ⇒ Response

Note:

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

Puts messages into the queue. You must use the messages endpoint to produce messages. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint.

Parameters:

  • queue_id (String) —

    The unique queue identifier.

  • put_messages_details (OCI::Queue::Models::PutMessagesDetails) —

    Details for the messages to publish.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

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

Returns:



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/oci/queue/queue_client.rb', line 434

def put_messages(queue_id, put_messages_details, opts = {})
  logger.debug 'Calling operation QueueClient#put_messages.' if logger

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

  path = '/queues/{queueId}/messages'.sub('{queueId}', queue_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 = @api_client.object_to_http_body(put_messages_details)

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

#update_message(queue_id, message_receipt, update_message_details, opts = {}) ⇒ Response

Note:

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

Updates the visibility of the message represented by the receipt. You must use the messages endpoint to update messages. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint.

Parameters:

  • queue_id (String) —

    The unique queue identifier.

  • message_receipt (String) —

    The receipt of the message retrieved from a GetMessages call.

  • update_message_details (OCI::Queue::Models::UpdateMessageDetails) —

    Details for the message 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) —

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

Returns:



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
 
# File 'lib/oci/queue/queue_client.rb', line 494

def update_message(queue_id, message_receipt, update_message_details, opts = {})
  logger.debug 'Calling operation QueueClient#update_message.' if logger

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

  path = '/queues/{queueId}/messages/{messageReceipt}'.sub('{queueId}', queue_id.to_s).sub('{messageReceipt}', message_receipt.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(update_message_details)

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

#update_messages(queue_id, update_messages_details, opts = {}) ⇒ Response

Note:

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

Updates multiple messages in the queue. You must use the messages endpoint to update messages. The messages endpoint may be different for different queues. Use get_queue to find the queue's messagesEndpoint.

Parameters:

  • queue_id (String) —

    The unique queue identifier.

  • update_messages_details (OCI::Queue::Models::UpdateMessagesDetails) —

    Details for the messages 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) —

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

Returns:



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/oci/queue/queue_client.rb', line 555

def update_messages(queue_id, update_messages_details, opts = {})
  logger.debug 'Calling operation QueueClient#update_messages.' if logger

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

  path = '/queues/{queueId}/messages/actions/updateMessages'.sub('{queueId}', queue_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 = @api_client.object_to_http_body(update_messages_details)

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