class OCI::ApmControlPlane::ApmDomainClient

Provide a set of APIs for tenant to perform operations like create, update, delete and list APM domains, and also work request APIs to monitor progress of these operations.

Attributes

api_client[R]

Client used to make HTTP requests. @return [OCI::ApiClient]

endpoint[R]

Fully qualified endpoint URL @return [String]

region[R]

The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]

retry_config[R]

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 @return [OCI::Retry::RetryConfig]

Public Class Methods

new(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) click to toggle source

Creates a new ApmDomainClient. 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.

@param [Config] config A Config object. @param [String] region A region used to determine the service endpoint. This will usually

correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer 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

@param [OCI::ApiClientProxySettings] proxy_settings 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

@param [OCI::Retry::RetryConfig] retry_config 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_control_plane/apm_domain_client.rb, line 54
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 "ApmDomainClient endpoint set to '#{@endpoint}'." if logger
end

Public Instance Methods

change_apm_domain_compartment(apm_domain_id, change_apm_domain_compartment_details, opts = {}) click to toggle source

Moves a APM Domain into a different compartment. When provided, If-Match is checked against ETag values of the resource. @param [String] apm_domain_id OCID of the APM Domain @param [OCI::ApmControlPlane::Models::ChangeApmDomainCompartmentDetails] change_apm_domain_compartment_details The information to be used in changing compartment. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :if_match 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.

@option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :opc_retry_token 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.

@return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/change_apm_domain_compartment.rb.html) to see an example of how to use change_apm_domain_compartment API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 123
def change_apm_domain_compartment(apm_domain_id, change_apm_domain_compartment_details, opts = {})
  logger.debug 'Calling operation ApmDomainClient#change_apm_domain_compartment.' if logger

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

  path = '/apmDomains/{apmDomainId}/actions/changeCompartment'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = @api_client.object_to_http_body(change_apm_domain_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#change_apm_domain_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end
create_apm_domain(create_apm_domain_details, opts = {}) click to toggle source

Creates a new APM Domain.

@param [OCI::ApmControlPlane::Models::CreateApmDomainDetails] create_apm_domain_details Details for the new APM Domain. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_retry_token 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.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/create_apm_domain.rb.html) to see an example of how to use create_apm_domain API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 187
def create_apm_domain(create_apm_domain_details, opts = {})
  logger.debug 'Calling operation ApmDomainClient#create_apm_domain.' if logger

  raise "Missing the required parameter 'create_apm_domain_details' when calling create_apm_domain." if create_apm_domain_details.nil?

  path = '/apmDomains'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-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_apm_domain_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#create_apm_domain') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end
delete_apm_domain(apm_domain_id, opts = {}) click to toggle source

Delete the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the returned work request to track the progress of the background activity to complete deleting the domain.

@param [String] apm_domain_id OCID of the APM Domain @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :if_match 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.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/delete_apm_domain.rb.html) to see an example of how to use delete_apm_domain API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 250
def delete_apm_domain(apm_domain_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#delete_apm_domain.' if logger

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

  path = '/apmDomains/{apmDomainId}'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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: 'ApmDomainClient#delete_apm_domain') 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
generate_data_keys(generate_data_keys_list_details, apm_domain_id, opts = {}) click to toggle source

Generates a set of new Data Keys for the specified APM domain with the specified names and types. These will be added to the existing set of Data Keys for the specified APM domain.

@param [Array<OCI::ApmControlPlane::Models::OCI::ApmControlPlane::Models::GenerateDataKeyDetails>] generate_data_keys_list_details List of new Data Keys to be generated. @param [String] apm_domain_id OCID of the APM Domain @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :if_match 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.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/generate_data_keys.rb.html) to see an example of how to use generate_data_keys API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 313
def generate_data_keys(generate_data_keys_list_details, apm_domain_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#generate_data_keys.' if logger

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

  path = '/apmDomains/{apmDomainId}/actions/generateDataKeys'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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(generate_data_keys_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#generate_data_keys') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end
get_apm_domain(apm_domain_id, opts = {}) click to toggle source

Gets details of APM Domain by identifier @param [String] apm_domain_id OCID of the APM Domain @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type {OCI::ApmControlPlane::Models::ApmDomain ApmDomain} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/get_apm_domain.rb.html) to see an example of how to use get_apm_domain API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 368
def get_apm_domain(apm_domain_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#get_apm_domain.' if logger

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

  path = '/apmDomains/{apmDomainId}'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#get_apm_domain') 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::ApmControlPlane::Models::ApmDomain'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
get_work_request(work_request_id, opts = {}) click to toggle source

Gets the details of the work request with the given ID. @param [String] work_request_id The ID of the asynchronous request. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type {OCI::ApmControlPlane::Models::WorkRequest WorkRequest} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/get_work_request.rb.html) to see an example of how to use get_work_request API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 422
def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#get_work_request') 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::ApmControlPlane::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_apm_domain_work_requests(apm_domain_id, opts = {}) click to toggle source

Returns a (paginated) list of work requests related to a specific APM Domain.

@param [String] apm_domain_id OCID of the APM Domain @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type Array<{OCI::ApmControlPlane::Models::WorkRequest WorkRequest}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/list_apm_domain_work_requests.rb.html) to see an example of how to use list_apm_domain_work_requests API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 477
def list_apm_domain_work_requests(apm_domain_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#list_apm_domain_work_requests.' if logger

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

  path = '/apmDomains/{apmDomainId}/workRequests'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

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

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#list_apm_domain_work_requests') 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: 'Array<OCI::ApmControlPlane::Models::WorkRequest>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_apm_domains(compartment_id, opts = {}) click to toggle source

Lists all APM Domains for the specified tenant compartment.

@param [String] compartment_id The ID of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :display_name A filter to return only resources that match the entire display name given. @option opts [String] :lifecycle_state A filter to return only resources that match the given life-cycle state. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. (default to ASC) @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

 (default to timeCreated)
Allowed values are: timeCreated, displayName

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type Array<{OCI::ApmControlPlane::Models::ApmDomainSummary ApmDomainSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/list_apm_domains.rb.html) to see an example of how to use list_apm_domains API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 540
def list_apm_domains(compartment_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#list_apm_domains.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_apm_domains." if compartment_id.nil?

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

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

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

  path = '/apmDomains'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'ApmDomainClient#list_apm_domains') 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: 'Array<OCI::ApmControlPlane::Models::ApmDomainSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_data_keys(apm_domain_id, opts = {}) click to toggle source

Lists all Data Keys for the specified APM Domain. The caller may filter the list by specifying the 'dataKeyType' query parameter.

@param [String] apm_domain_id OCID of the APM Domain @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :data_key_type Data key type. @option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type Array<{OCI::ApmControlPlane::Models::DataKeySummary DataKeySummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/list_data_keys.rb.html) to see an example of how to use list_data_keys API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 615
def list_data_keys(apm_domain_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#list_data_keys.' if logger

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

  if opts[:data_key_type] && !OCI::ApmControlPlane::Models::DATA_KEY_TYPES_ENUM.include?(opts[:data_key_type])
    raise 'Invalid value for "data_key_type", must be one of the values in OCI::ApmControlPlane::Models::DATA_KEY_TYPES_ENUM.'
  end
  raise "Parameter value for 'apm_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(apm_domain_id)

  path = '/apmDomains/{apmDomainId}/dataKeys'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:dataKeyType] = opts[:data_key_type] if opts[:data_key_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: 'ApmDomainClient#list_data_keys') 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: 'Array<OCI::ApmControlPlane::Models::DataKeySummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_work_request_errors(work_request_id, opts = {}) click to toggle source

Return a (paginated) list of errors for a given work request.

@param [String] work_request_id The ID of the asynchronous request. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @return [Response] A Response object with data of type Array<{OCI::ApmControlPlane::Models::WorkRequestError WorkRequestError}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/list_work_request_errors.rb.html) to see an example of how to use list_work_request_errors API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 677
def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#list_work_request_errors.' if logger

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

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'ApmDomainClient#list_work_request_errors') 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: 'Array<OCI::ApmControlPlane::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_work_request_logs(work_request_id, opts = {}) click to toggle source

Return a (paginated) list of logs for a given work request.

@param [String] work_request_id The ID of the asynchronous request. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @return [Response] A Response object with data of type Array<{OCI::ApmControlPlane::Models::WorkRequestLogEntry WorkRequestLogEntry}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/list_work_request_logs.rb.html) to see an example of how to use list_work_request_logs API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 736
def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#list_work_request_logs.' if logger

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

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'ApmDomainClient#list_work_request_logs') 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: 'Array<OCI::ApmControlPlane::Models::WorkRequestLogEntry>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_work_requests(compartment_id, opts = {}) click to toggle source

Returns a (paginated) list of work requests in a given compartment.

@param [String] compartment_id The ID of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @return [Response] A Response object with data of type Array<{OCI::ApmControlPlane::Models::WorkRequest WorkRequest}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/list_work_requests.rb.html) to see an example of how to use list_work_requests API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 795
def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation ApmDomainClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  path = '/workRequests'
  operation_signing_strategy = :standard

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

  # 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: 'ApmDomainClient#list_work_requests') 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: 'Array<OCI::ApmControlPlane::Models::WorkRequest>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
logger() click to toggle source

@return [Logger] The logger for this client. May be nil.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 93
def logger
  @api_client.config.logger
end
region=(new_region) click to toggle source

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

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 83
def region=(new_region)
  @region = new_region

  raise 'A region must be specified.' unless @region

  @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://apm-cp.{region}.oci.{secondLevelDomain}') + '/20200630'
  logger.info "ApmDomainClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
end
remove_data_keys(apm_domain_id, remove_data_keys_list_details, opts = {}) click to toggle source

Removes the set of specified Data Keys from the specified APM domain. Agents would no longer be able to use these data keys to upload to the APM domain once this operation is completed.

@param [String] apm_domain_id OCID of the APM Domain @param [Array<OCI::ApmControlPlane::Models::OCI::ApmControlPlane::Models::RemoveDataKeyDetails>] remove_data_keys_list_details List of Data Keys to be removed. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :if_match 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.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/remove_data_keys.rb.html) to see an example of how to use remove_data_keys API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 860
def remove_data_keys(apm_domain_id, remove_data_keys_list_details, opts = {})
  logger.debug 'Calling operation ApmDomainClient#remove_data_keys.' if logger

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

  path = '/apmDomains/{apmDomainId}/actions/removeDataKeys'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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(remove_data_keys_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ApmDomainClient#remove_data_keys') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end
update_apm_domain(apm_domain_id, update_apm_domain_details, opts = {}) click to toggle source

Update the APM domain when it is ready and active. @param [String] apm_domain_id OCID of the APM Domain @param [OCI::ApmControlPlane::Models::UpdateApmDomainDetails] update_apm_domain_details The information to be updated for the APM Domain. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config 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

@option opts [String] :if_match 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.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmcontrolplane/update_apm_domain.rb.html) to see an example of how to use update_apm_domain API.

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 922
def update_apm_domain(apm_domain_id, update_apm_domain_details, opts = {})
  logger.debug 'Calling operation ApmDomainClient#update_apm_domain.' if logger

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

  path = '/apmDomains/{apmDomainId}'.sub('{apmDomainId}', apm_domain_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'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_apm_domain_details)

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

Private Instance Methods

applicable_retry_config(opts = {}) click to toggle source

rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines

# File lib/oci/apm_control_plane/apm_domain_client.rb, line 966
def applicable_retry_config(opts = {})
  return @retry_config unless opts.key?(:retry_config)

  opts[:retry_config]
end