Class: OCI::ApmSynthetics::ApmSyntheticClient

Inherits:

Object

Object
OCI::ApmSynthetics::ApmSyntheticClient

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

#api_client ⇒ OCI::ApiClient readonly

Client used to make HTTP requests.
#endpoint ⇒ String readonly

Fully qualified endpoint URL.
#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.
#retry_config ⇒ OCI::Retry::RetryConfig readonly

The default retry configuration to apply to all operations in this service client.

Instance Method Summary collapse

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

Gets aggregated network data for given executions.
#create_dedicated_vantage_point(apm_domain_id, create_dedicated_vantage_point_details, opts = {}) ⇒ Response

Registers a new dedicated vantage point.
#create_monitor(apm_domain_id, create_monitor_details, opts = {}) ⇒ Response

Creates a new monitor.
#create_on_premise_vantage_point(apm_domain_id, create_on_premise_vantage_point_details, opts = {}) ⇒ Response

Registers a new On-premise vantage point.
#create_script(apm_domain_id, create_script_details, opts = {}) ⇒ Response

Creates a new script.
#create_worker(apm_domain_id, on_premise_vantage_point_id, create_worker_details, opts = {}) ⇒ Response

Registers a new worker.
#delete_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, opts = {}) ⇒ Response

Deregisters the specified dedicated vantage point.
#delete_monitor(apm_domain_id, monitor_id, opts = {}) ⇒ Response

Deletes the specified monitor.
#delete_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, opts = {}) ⇒ Response

Deregisters the specified On-premise vantage point.
#delete_script(apm_domain_id, script_id, opts = {}) ⇒ Response

Deletes the specified script.
#delete_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, opts = {}) ⇒ Response

Deregisters the specified worker.
#get_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, opts = {}) ⇒ Response

Gets the details of the dedicated vantage point identified by the OCID.
#get_monitor(apm_domain_id, monitor_id, opts = {}) ⇒ Response

Gets the configuration of the monitor identified by the OCID.
#get_monitor_result(apm_domain_id, monitor_id, vantage_point, result_type, result_content_type, execution_time, opts = {}) ⇒ Response

Gets the results for a specific execution of a monitor identified by OCID.
#get_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, opts = {}) ⇒ Response

Gets the details of the On-premise vantage point identified by the OCID.
#get_script(apm_domain_id, script_id, opts = {}) ⇒ Response

Gets the configuration of the script identified by the OCID.
#get_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, opts = {}) ⇒ Response

Gets the details of the worker identified by the OCID.
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ApmSyntheticClient constructor

Creates a new ApmSyntheticClient.
#list_dedicated_vantage_points(apm_domain_id, opts = {}) ⇒ Response

Returns a list of dedicated vantage points.
#list_monitors(apm_domain_id, opts = {}) ⇒ Response

Returns a list of monitors.
#list_on_premise_vantage_points(apm_domain_id, opts = {}) ⇒ Response

Returns a list of On-premise vantage points.
#list_public_vantage_points(apm_domain_id, opts = {}) ⇒ Response

Returns a list of public vantage points.
#list_scripts(apm_domain_id, opts = {}) ⇒ Response

Returns a list of scripts.
#list_workers(apm_domain_id, on_premise_vantage_point_id, opts = {}) ⇒ Response

Returns a list of workers.
#logger ⇒ Logger

The logger for this client.
#update_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, update_dedicated_vantage_point_details, opts = {}) ⇒ Response

Updates the dedicated vantage point.
#update_monitor(apm_domain_id, monitor_id, update_monitor_details, opts = {}) ⇒ Response

Updates the monitor.
#update_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, update_on_premise_vantage_point_details, opts = {}) ⇒ Response

Updates the On-premise vantage point.
#update_script(apm_domain_id, script_id, update_script_details, opts = {}) ⇒ Response

Updates the script.
#update_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, update_worker_details, opts = {}) ⇒ Response

Updates the worker.

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

# 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_client ⇒ `OCI::ApiClient` (readonly)

Client used to make HTTP requests.

Returns:

(OCI::ApiClient)



15
16
17

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

def api_client
  @api_client
end

#endpoint ⇒ `String` (readonly)

Fully qualified endpoint URL

Returns:

(String)



19
20
21

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

def endpoint
  @endpoint
end

#region ⇒ `String`

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

Returns:

(String)



29
30
31

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

def region
  @region
end

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

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

Returns:

(OCI::Retry::RetryConfig)



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:

(Response) —

A Response object with data of type AggregatedNetworkDataResult

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

(Response) —

A Response object with data of type DedicatedVantagePoint

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

(Response) —

A Response object with data of type Monitor

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

(Response) —

A Response object with data of type OnPremiseVantagePoint

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

(Response) —

A Response object with data of type Script

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

(Response) —

A Response object with data of type Worker

# 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

# 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

# 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

# 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

# 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

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

(Response) —

A Response object with data of type DedicatedVantagePoint

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

(Response) —

A Response object with data of type Monitor

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

(Response) —

A Response object with data of type MonitorResult

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

(Response) —

A Response object with data of type OnPremiseVantagePoint

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

(Response) —

A Response object with data of type Script

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

(Response) —

A Response object with data of type Worker

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

(Response) —

A Response object with data of type DedicatedVantagePointCollection

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

(Response) —

A Response object with data of type MonitorCollection

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

(Response) —

A Response object with data of type OnPremiseVantagePointCollection

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

(Response) —

A Response object with data of type PublicVantagePointCollection

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

(Response) —

A Response object with data of type ScriptCollection

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

(Response) —

A Response object with data of type WorkerCollection

# 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

#logger ⇒ `Logger`

Returns The logger for this client. May be nil.

Returns:

(Logger) —

The logger for this client. May be nil.



94
95
96

# File 'lib/oci/apm_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:

(Response) —

A Response object with data of type DedicatedVantagePoint

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

(Response) —

A Response object with data of type Monitor

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

(Response) —

A Response object with data of type OnPremiseVantagePoint

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

(Response) —

A Response object with data of type Script

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

(Response) —

A Response object with data of type Worker

# 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

Class: OCI::ApmSynthetics::ApmSyntheticClient

Overview

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

#endpoint ⇒ String (readonly)

#region ⇒ String

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

Instance Method Details

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

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

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

#create_on_premise_vantage_point(apm_domain_id, create_on_premise_vantage_point_details, opts = {}) ⇒ Response

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#logger ⇒ Logger

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

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

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

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

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

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

#api_client ⇒ `OCI::ApiClient` (readonly)

#endpoint ⇒ `String` (readonly)

#region ⇒ `String`

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

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

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

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

#create_on_premise_vantage_point(apm_domain_id, create_on_premise_vantage_point_details, opts = {}) ⇒ `Response`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#list_on_premise_vantage_points(apm_domain_id, opts = {}) ⇒ `Response`

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

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

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

#logger ⇒ `Logger`

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

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

#update_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, update_on_premise_vantage_point_details, opts = {}) ⇒ `Response`

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

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