Class: OCI::ApmSynthetics::ApmSyntheticClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/apm_synthetic_client.rb

Overview

Use the Application Performance Monitoring Synthetic Monitoring API to query synthetic scripts and monitors.

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

Creates a new ApmSyntheticClient. 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/apm_synthetics/apm_synthetic_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 + '/20200630'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ApmSyntheticClient 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/apm_synthetics/apm_synthetic_client.rb', line 13

def api_client
  @api_client
end

#endpointString (readonly)

Fully qualified endpoint URL

Returns:

  • (String)


17
18
19
# File 'lib/oci/apm_synthetics/apm_synthetic_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/apm_synthetics/apm_synthetic_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/apm_synthetics/apm_synthetic_client.rb', line 23

def retry_config
  @retry_config
end

Instance Method Details

#create_monitor(apm_domain_id, create_monitor_details, opts = {}) ⇒ Response

Note:

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

Creates a new monitor.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • create_monitor_details (OCI::ApmSynthetics::Models::CreateMonitorDetails)

    The configuration details for creating a monitor.

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

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

Returns:



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
153
154
155
156
157
158
159
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 120

def create_monitor(apm_domain_id, create_monitor_details, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#create_monitor.' if logger

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

  path = '/monitors'
  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-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_monitor_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#create_monitor') 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::ApmSynthetics::Models::Monitor'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_script(apm_domain_id, create_script_details, opts = {}) ⇒ Response

Note:

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

Creates a new script.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • create_script_details (OCI::ApmSynthetics::Models::CreateScriptDetails)

    The configuration details for creating a script.

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

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

Returns:



188
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
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 188

def create_script(apm_domain_id, create_script_details, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#create_script.' if logger

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

  path = '/scripts'
  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-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_script_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#create_script') 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::ApmSynthetics::Models::Script'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_monitor(apm_domain_id, monitor_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified monitor.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • monitor_id (String)

    The OCID of the monitor.

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



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
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 255

def delete_monitor(apm_domain_id, monitor_id, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#delete_monitor.' if logger

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

  path = '/monitors/{monitorId}'.sub('{monitorId}', monitor_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#delete_monitor') 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_script(apm_domain_id, script_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified script.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • script_id (String)

    The OCID of the script.

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 321

def delete_script(apm_domain_id, script_id, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#delete_script.' if logger

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

  path = '/scripts/{scriptId}'.sub('{scriptId}', script_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#delete_script') 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_monitor(apm_domain_id, monitor_id, opts = {}) ⇒ Response

Note:

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

Gets the configuration of the monitor identified by the OCID.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • monitor_id (String)

    The OCID of the monitor.

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

Returns:



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
413
414
415
416
417
418
419
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 381

def get_monitor(apm_domain_id, monitor_id, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#get_monitor.' if logger

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

  path = '/monitors/{monitorId}'.sub('{monitorId}', monitor_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#get_monitor') 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::ApmSynthetics::Models::Monitor'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_monitor_result(apm_domain_id, monitor_id, vantage_point, result_type, result_content_type, execution_time, opts = {}) ⇒ Response

Note:

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

Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, or Console Log.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • monitor_id (String)

    The OCID of the monitor.

  • vantage_point (String)

    The vantagePoint name.

  • result_type (String)

    The result type har or screenshot or log.

  • result_content_type (String)

    The result content type zip or raw.

  • execution_time (String)

    The time the object was posted.

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

Returns:



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
496
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 450

def get_monitor_result(apm_domain_id, monitor_id, vantage_point, result_type, result_content_type, execution_time, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#get_monitor_result.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling get_monitor_result." if apm_domain_id.nil?
  raise "Missing the required parameter 'monitor_id' when calling get_monitor_result." if monitor_id.nil?
  raise "Missing the required parameter 'vantage_point' when calling get_monitor_result." if vantage_point.nil?
  raise "Missing the required parameter 'result_type' when calling get_monitor_result." if result_type.nil?
  raise "Missing the required parameter 'result_content_type' when calling get_monitor_result." if result_content_type.nil?
  raise "Missing the required parameter 'execution_time' when calling get_monitor_result." if execution_time.nil?
  raise "Parameter value for 'monitor_id' must not be blank" if OCI::Internal::Util.blank_string?(monitor_id)
  raise "Parameter value for 'execution_time' must not be blank" if OCI::Internal::Util.blank_string?(execution_time)

  path = '/monitors/{monitorId}/results/{executionTime}'.sub('{monitorId}', monitor_id.to_s).sub('{executionTime}', execution_time.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:vantagePoint] = vantage_point
  query_params[:resultType] = result_type
  query_params[:resultContentType] = result_content_type

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#get_monitor_result') 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::ApmSynthetics::Models::MonitorResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_script(apm_domain_id, script_id, opts = {}) ⇒ Response

Note:

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

Gets the configuration of the script identified by the OCID.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • script_id (String)

    The OCID of the script.

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

Returns:



518
519
520
521
522
523
524
525
526
527
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
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 518

def get_script(apm_domain_id, script_id, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#get_script.' if logger

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

  path = '/scripts/{scriptId}'.sub('{scriptId}', script_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#get_script') 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::ApmSynthetics::Models::Script'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of monitors.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • 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

  • :display_name (String)

    A filter to return only resources that match the entire display name given.

  • :script_id (String)

    A filter to return only monitors using scriptId.

  • :monitor_type (String)

    A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

  • :status (String)

    A filter to return only monitors that match the status given.

  • :limit (Integer)

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

  • :page (String)

    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.

    Example: 50

  • :sort_order (String)

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

  • :sort_by (String)

    The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive. (default to displayName) Allowed values are: displayName, timeCreated, timeUpdated, status, monitorType

  • :opc_request_id (String)

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

Returns:



599
600
601
602
603
604
605
606
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
650
651
652
653
654
655
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 599

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

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

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

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

  if opts[:sort_by] && !%w[displayName timeCreated timeUpdated status monitorType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, timeUpdated, status, monitorType.'
  end

  path = '/monitors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:scriptId] = opts[:script_id] if opts[:script_id]
  query_params[:monitorType] = opts[:monitor_type] if opts[:monitor_type]
  query_params[:status] = opts[:status] if opts[:status]
  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]

  # 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: 'ApmSyntheticClient#list_monitors') 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::ApmSynthetics::Models::MonitorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of public vantage points.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

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

  • :page (String)

    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.

    Example: 50

  • :sort_order (String)

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

  • :sort_by (String)

    The field to sort by. You can provide one sort by (sortBy). Default order for displayName or name is ascending. The displayName or name sort by is case insensitive. (default to displayName) Allowed values are: name, displayName

  • :display_name (String)

    A filter to return only resources that match the entire display name given.

  • :name (String)

    A filter to return only resources that match the entire name given.

  • :opc_request_id (String)

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

Returns:



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
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 692

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

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

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

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

  path = '/publicVantagePoints'
  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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:name] = opts[:name] if opts[:name]

  # 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: 'ApmSyntheticClient#list_public_vantage_points') 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::ApmSynthetics::Models::PublicVantagePointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of scripts.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

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

  • :display_name (String)

    A filter to return only resources that match the entire display name given.

  • :content_type (String)

    A filter to return only resources that match the content type given.

  • :limit (Integer)

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

  • :page (String)

    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.

    Example: 50

  • :sort_order (String)

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

  • :sort_by (String)

    The field to sort by. Only one sort order may be provided. Default order of displayName and contentType is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive. (default to displayName) Allowed values are: displayName, timeCreated, timeUpdated, contentType

Returns:



781
782
783
784
785
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
828
829
830
831
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 781

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

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

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

  if opts[:sort_by] && !%w[displayName timeCreated timeUpdated contentType].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, timeUpdated, contentType.'
  end

  path = '/scripts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:contentType] = opts[:content_type] if opts[:content_type]
  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]

  # 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: 'ApmSyntheticClient#list_scripts') 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::ApmSynthetics::Models::ScriptCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#loggerLogger

Returns The logger for this client. May be nil.

Returns:

  • (Logger)

    The logger for this client. May be nil.



92
93
94
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 92

def logger
  @api_client.config.logger
end

#update_monitor(apm_domain_id, monitor_id, update_monitor_details, opts = {}) ⇒ Response

Note:

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

Updates the monitor.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • monitor_id (String)

    The OCID of the monitor.

  • update_monitor_details (OCI::ApmSynthetics::Models::UpdateMonitorDetails)

    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)

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

Returns:



860
861
862
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
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 860

def update_monitor(apm_domain_id, monitor_id, update_monitor_details, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#update_monitor.' if logger

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

  path = '/monitors/{monitorId}'.sub('{monitorId}', monitor_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_monitor_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#update_monitor') 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::ApmSynthetics::Models::Monitor'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_script(apm_domain_id, script_id, update_script_details, opts = {}) ⇒ Response

Note:

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

Updates the script.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • script_id (String)

    The OCID of the script.

  • update_script_details (OCI::ApmSynthetics::Models::UpdateScriptDetails)

    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)

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

Returns:



929
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/apm_synthetics/apm_synthetic_client.rb', line 929

def update_script(apm_domain_id, script_id, update_script_details, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#update_script.' if logger

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

  path = '/scripts/{scriptId}'.sub('{scriptId}', script_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]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_script_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmSyntheticClient#update_script') 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::ApmSynthetics::Models::Script'
    )
  end
  # rubocop:enable Metrics/BlockLength
end