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



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_synthetics/apm_synthetic_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 "ApmSyntheticClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_clientOCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 15

def api_client
  @api_client
end

#endpointString (readonly)

Fully qualified endpoint URL

Returns:

  • (String)


19
20
21
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 19

def endpoint
  @endpoint
end

#regionString

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

Returns:

  • (String)


29
30
31
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 29

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



25
26
27
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

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

Note:

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

Gets aggregated network data for given executions.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • monitor_id (String)

    The OCID of the monitor.

  • aggregate_network_data_details (OCI::ApmSynthetics::Models::AggregateNetworkDataDetails)

    Details of the vantage point and corresponding execution times.

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



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
160
161
162
163
164
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 123

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

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

  path = '/monitors/{monitorId}/actions/aggregateNetworkData'.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-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(aggregate_network_data_details)

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

#create_dedicated_vantage_point(apm_domain_id, create_dedicated_vantage_point_details, opts = {}) ⇒ Response

Note:

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

Registers a new dedicated vantage point.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • create_dedicated_vantage_point_details (OCI::ApmSynthetics::Models::CreateDedicatedVantagePointDetails)

    The configuration details for registering a dedicated vantage point.

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



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

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

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

  path = '/dedicatedVantagePoints'
  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_dedicated_vantage_point_details)

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

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 261

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_on_premise_vantage_point(apm_domain_id, create_on_premise_vantage_point_details, opts = {}) ⇒ Response

Note:

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

Registers a new On-premise vantage point.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • create_on_premise_vantage_point_details (OCI::ApmSynthetics::Models::CreateOnPremiseVantagePointDetails)

    The configuration details for registering an On-premise vantage point.

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



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
360
361
362
363
364
365
366
367
368
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 329

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

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

  path = '/onPremiseVantagePoints'
  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_on_premise_vantage_point_details)

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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 397

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

#create_worker(apm_domain_id, on_premise_vantage_point_id, create_worker_details, opts = {}) ⇒ Response

Note:

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

Registers a new worker.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

  • create_worker_details (OCI::ApmSynthetics::Models::CreateWorkerDetails)

    The configuration details for registering a worker for an On-premise vantage point.

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



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
497
498
499
500
501
502
503
504
505
506
507
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 466

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

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}/workers/'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_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-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_worker_details)

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

#delete_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, opts = {}) ⇒ Response

Note:

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

Deregisters the specified dedicated vantage point.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • dedicated_vantage_point_id (String)

    The OCID of the dedicated vantage point.

  • 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



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 535

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

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

  path = '/dedicatedVantagePoints/{dedicatedVantagePointId}'.sub('{dedicatedVantagePointId}', dedicated_vantage_point_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_dedicated_vantage_point') 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_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



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

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_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, opts = {}) ⇒ Response

Note:

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

Deregisters the specified On-premise vantage point.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

  • 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



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 667

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

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_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_on_premise_vantage_point') 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



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 733

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

#delete_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, opts = {}) ⇒ Response

Note:

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

Deregisters the specified worker.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

  • worker_id (String)

    The OCID of the On-premise vantage point worker.

  • 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



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
832
833
834
835
836
837
838
839
840
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 800

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

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}/workers/{workerId}'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_id.to_s).sub('{workerId}', worker_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_worker') 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_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the dedicated vantage point identified by the OCID.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • dedicated_vantage_point_id (String)

    The OCID of the dedicated vantage point.

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



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 862

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

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

  path = '/dedicatedVantagePoints/{dedicatedVantagePointId}'.sub('{dedicatedVantagePointId}', dedicated_vantage_point_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_dedicated_vantage_point') 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::DedicatedVantagePoint'
    )
  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:



922
923
924
925
926
927
928
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
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 922

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, Console Log or Network details.

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, screenshot, log, or network.

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



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 991

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_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the On-premise vantage point identified by the OCID.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

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



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

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

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_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_on_premise_vantage_point') 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::OnPremiseVantagePoint'
    )
  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:



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1119

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

#get_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the worker identified by the OCID.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

  • worker_id (String)

    The OCID of the On-premise vantage point worker.

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



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

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

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}/workers/{workerId}'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_id.to_s).sub('{workerId}', worker_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_worker') 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::Worker'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of dedicated 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)

    The maximum number of results per page, or items to return in a paginated "List" call. For information on 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-sensitive. (default to displayName) Allowed values are: displayName, name, timeCreated, timeUpdated, status

  • :display_name (String)

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

  • :name (String)

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

  • :status (String)

    A filter to return only the dedicated vantage points that match a given status.

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



1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1260

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

  raise "Missing the required parameter 'apm_domain_id' when calling list_dedicated_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[displayName name timeCreated timeUpdated status].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, name, timeCreated, timeUpdated, status.'
  end

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

  path = '/dedicatedVantagePoints'
  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]
  query_params[:status] = opts[:status] if opts[:status]

  # 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_dedicated_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::DedicatedVantagePointCollection'
    )
  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 the resources that match the entire display name.

  • :script_id (String)

    A filter to return only monitors using scriptId.

  • :vantage_point (String)

    The name of the public or dedicated vantage point.

  • :monitor_type (String)

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

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

    The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination.

    Example: 50

  • :is_maintenance_window_active (BOOLEAN)

    A filter to return the monitors whose maintenance window is currently active.

  • :is_maintenance_window_set (BOOLEAN)

    A filter to return the monitors whose maintenance window is set.

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

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



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1362

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 maintenanceWindowTimeStarted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, timeUpdated, status, monitorType, maintenanceWindowTimeStarted.'
  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[:vantagePoint] = opts[:vantage_point] if opts[:vantage_point]
  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[:isMaintenanceWindowActive] = opts[:is_maintenance_window_active] if !opts[:is_maintenance_window_active].nil?
  query_params[:isMaintenanceWindowSet] = opts[:is_maintenance_window_set] if !opts[:is_maintenance_window_set].nil?
  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_on_premise_vantage_points(apm_domain_id, opts = {}) ⇒ Response

Note:

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

Returns a list of On-premise 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)

    The maximum number of results per page, or items to return in a paginated "List" call. For information on 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-sensitive. (default to displayName) Allowed values are: displayName, name, timeCreated, timeUpdated

  • :display_name (String)

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

  • :name (String)

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

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



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1460

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

  raise "Missing the required parameter 'apm_domain_id' when calling list_on_premise_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[displayName name timeCreated timeUpdated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, name, timeCreated, timeUpdated.'
  end

  path = '/onPremiseVantagePoints'
  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_on_premise_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::OnPremiseVantagePointCollection'
    )
  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)

    The maximum number of results per page, or items to return in a paginated "List" call. For information on 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 the resources that match the entire display name.

  • :name (String)

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

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



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1547

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 the resources that match the entire display name.

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

    The maximum number of results per page, or items to return in a paginated "List" call. For information on 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:



1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1636

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

#list_workers(apm_domain_id, on_premise_vantage_point_id, opts = {}) ⇒ Response

Note:

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

Returns a list of workers.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

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

    The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination.

    Example: 50

  • :status (String)

    A filter to return only On-premise VP workers that match the status given.

  • :capability (String)

    A filter to return only On-premise VP workers that match the capability given.

  • :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, timeUpdated and timeLastSyncup is descending. The displayName sort by is case-sensitive. (default to displayName) Allowed values are: displayName, name, status, priority, timeCreated, timeUpdated, timeLastSyncup

  • :display_name (String)

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

  • :name (String)

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

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



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1728

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

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

  if opts[:status] && !OCI::ApmSynthetics::Models::ON_PREMISE_VANTAGE_POINT_WORKER_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::ApmSynthetics::Models::ON_PREMISE_VANTAGE_POINT_WORKER_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 name status priority timeCreated timeUpdated timeLastSyncup].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, name, status, priority, timeCreated, timeUpdated, timeLastSyncup.'
  end
  raise "Parameter value for 'on_premise_vantage_point_id' must not be blank" if OCI::Internal::Util.blank_string?(on_premise_vantage_point_id)

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}/workers/'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_id.to_s)
  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[:status] = opts[:status] if opts[:status]
  query_params[:capability] = opts[:capability] if opts[:capability]
  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_workers') 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::WorkerCollection'
    )
  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.



94
95
96
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, update_dedicated_vantage_point_details, opts = {}) ⇒ Response

Note:

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

Updates the dedicated vantage point.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • dedicated_vantage_point_id (String)

    The OCID of the dedicated vantage point.

  • update_dedicated_vantage_point_details (OCI::ApmSynthetics::Models::UpdateDedicatedVantagePointDetails)

    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:



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1815

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

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

  path = '/dedicatedVantagePoints/{dedicatedVantagePointId}'.sub('{dedicatedVantagePointId}', dedicated_vantage_point_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_dedicated_vantage_point_details)

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



1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1884

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_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, update_on_premise_vantage_point_details, opts = {}) ⇒ Response

Note:

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

Updates the On-premise vantage point.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

  • update_on_premise_vantage_point_details (OCI::ApmSynthetics::Models::UpdateOnPremiseVantagePointDetails)

    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:



1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 1953

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

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_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_on_premise_vantage_point_details)

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



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 2022

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

#update_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, update_worker_details, opts = {}) ⇒ Response

Note:

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

Updates the worker.

Parameters:

  • apm_domain_id (String)

    The APM domain ID the request is intended for.

  • on_premise_vantage_point_id (String)

    The OCID of the On-premise vantage point.

  • worker_id (String)

    The OCID of the On-premise vantage point worker.

  • update_worker_details (OCI::ApmSynthetics::Models::UpdateWorkerDetails)

    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:



2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
# File 'lib/oci/apm_synthetics/apm_synthetic_client.rb', line 2092

def update_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, update_worker_details, opts = {})
  logger.debug 'Calling operation ApmSyntheticClient#update_worker.' if logger

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

  path = '/onPremiseVantagePoints/{onPremiseVantagePointId}/workers/{workerId}'.sub('{onPremiseVantagePointId}', on_premise_vantage_point_id.to_s).sub('{workerId}', worker_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_worker_details)

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