Class: OCI::ApmTraces::ScheduledQueryClient

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

Overview

Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer. For more information, see Application Performance Monitoring.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ScheduledQueryClient

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



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

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


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

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


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

def region
  @region
end

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

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

Returns:



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

def retry_config
  @retry_config
end

Instance Method Details

#create_scheduled_query(apm_domain_id, create_scheduled_query_details, opts = {}) ⇒ Response

Note:

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

Create a scheduled query in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • create_scheduled_query_details (OCI::ApmTraces::Models::CreateScheduledQueryDetails) —

    Request body containing the details about the scheduled query 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) —

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

  • :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_dry_run (String) —

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

Returns:



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/apm_traces/scheduled_query_client.rb', line 126

def create_scheduled_query(apm_domain_id, create_scheduled_query_details, opts = {})
  logger.debug 'Calling operation ScheduledQueryClient#create_scheduled_query.' if logger

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

  path = '/scheduledQueries'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_scheduled_query_details)

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

#delete_scheduled_query(apm_domain_id, scheduled_query_id, opts = {}) ⇒ Response

Note:

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

Delete a scheduled query in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • scheduled_query_id (String) —

    Id of the scheduled query.

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

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



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
236
237
238
239
240
241
242
 
# File 'lib/oci/apm_traces/scheduled_query_client.rb', line 202

def delete_scheduled_query(apm_domain_id, scheduled_query_id, opts = {})
  logger.debug 'Calling operation ScheduledQueryClient#delete_scheduled_query.' if logger

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

  path = '/scheduledQueries/{scheduledQueryId}'.sub('{scheduledQueryId}', scheduled_query_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  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: 'ScheduledQueryClient#delete_scheduled_query') 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_scheduled_query(apm_domain_id, scheduled_query_id, opts = {}) ⇒ Response

Note:

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

Retrieve a scheduled query in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • scheduled_query_id (String) —

    Id of the scheduled query.

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

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



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

def get_scheduled_query(apm_domain_id, scheduled_query_id, opts = {})
  logger.debug 'Calling operation ScheduledQueryClient#get_scheduled_query.' if logger

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

  path = '/scheduledQueries/{scheduledQueryId}'.sub('{scheduledQueryId}', scheduled_query_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  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: 'ScheduledQueryClient#get_scheduled_query') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ApmTraces::Models::ScheduledQuery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of all scheduled queries in the APM Domain.

Allowed values are: SCHEDULED_QUERY_NAME, SCHEDULED_QUERY_TYPE, SCHEDULED_QUERY_SUB_TYPE, SCHEDULED_QUERY_NEXT_RUN, SCHEDULED_QUERY_SCHEDULE

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended 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) —

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

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

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page where to start retrieving results. This is usually retrieved from a previous response. (default to 1)

  • :display_name (String) —

    A filter to return resources that match the given display name. This will return resources that have name starting with this filter.

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort by. You can provide one "sortBy" value. (default to SCHEDULED_QUERY_NAME)

Returns:



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
396
397
398
399
400
401
402
403
 
# File 'lib/oci/apm_traces/scheduled_query_client.rb', line 352

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

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

  if opts[:sort_order] && !OCI::ApmTraces::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::ApmTraces::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[SCHEDULED_QUERY_NAME SCHEDULED_QUERY_TYPE SCHEDULED_QUERY_SUB_TYPE SCHEDULED_QUERY_NEXT_RUN SCHEDULED_QUERY_SCHEDULE].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of SCHEDULED_QUERY_NAME, SCHEDULED_QUERY_TYPE, SCHEDULED_QUERY_SUB_TYPE, SCHEDULED_QUERY_NEXT_RUN, SCHEDULED_QUERY_SCHEDULE.'
  end

  path = '/scheduledQueries'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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: 'ScheduledQueryClient#list_scheduled_queries') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ApmTraces::Models::ScheduledQueryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



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

def logger
  @api_client.config.logger
end

#update_scheduled_query(apm_domain_id, scheduled_query_id, update_scheduled_query_details, opts = {}) ⇒ Response

Note:

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

Update a scheduled query in the APM Domain.

Parameters:

  • apm_domain_id (String) —

    The APM Domain ID for the intended request.

  • scheduled_query_id (String) —

    Id of the scheduled query.

  • update_scheduled_query_details (OCI::ApmTraces::Models::UpdateScheduledQueryDetails) —

    Request body containing the details about the scheduled query to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

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

  • :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_dry_run (String) —

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

Returns:



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

def update_scheduled_query(apm_domain_id, scheduled_query_id, update_scheduled_query_details, opts = {})
  logger.debug 'Calling operation ScheduledQueryClient#update_scheduled_query.' if logger

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

  path = '/scheduledQueries/{scheduledQueryId}'.sub('{scheduledQueryId}', scheduled_query_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-dry-run'] = opts[:opc_dry_run] if opts[:opc_dry_run]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_scheduled_query_details)

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