lib/oci/apm_traces/query_client.rb
# Returns a list of predefined quick pick queries intended to assist the user
# to choose a query to run.  There is no sorting applied on the results.
#
# @param [String] apm_domain_id The APM Domain Id the request is intended for.
#
# @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 Unique Oracle-assigned identifier for the request.  If you need to contact Oracle about a
#   particular request, please provide the request ID.
#
# @option opts [Integer] :limit The maximum number of items to return.
#    (default to 50)
# @option opts [String] :page The page token representing the page at which to start retrieving results.
#   This is usually retrieved from a previous response.
#    (default to 1)
# @return [Response] A Response object with data of type Array<{OCI::ApmTraces::Models::QuickPickSummary QuickPickSummary}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmtraces/list_quick_picks.rb.html) to see an example of how to use list_quick_picks API.
Returns a list of predefined quick pick queries intended to assist the user
to choose a query to run.  There is no sorting applied on the results.
Returns a list of predefined quick pick queries intended to assist the user to choose a query to run . There is no sorting applied on the results .
def list_quick_picks(apm_domain_id, opts = {})
      logger.debug 'Calling operation QueryClient#list_quick_picks.' if logger
      raise "Missing the required parameter 'apm_domain_id' when calling list_quick_picks." if apm_domain_id.nil?
      path = '/queries/quickPicks'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:apmDomainId] = apm_domain_id
      query_params[:limit] = opts[:limit] if opts[:limit]
      query_params[:page] = opts[:page] if opts[:page]
      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]
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'QueryClient#list_quick_picks') 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::ApmTraces::Models::QuickPickSummary>'
        )
      end
    end
def list_quick_picks ( apm_domain_id , opts = { } ) logger . debug 'Calling operation QueryClient#list_quick_picks.' if logger raise "Missing the required parameter 'apm_domain_id' when calling list_quick_picks." if apm_domain_id . nil? path = '/queries/quickPicks' operation_signing_strategy = :standard query_params = { } query_params [ :apmDomainId ] = apm_domain_id query_params [ :limit ] = opts [ :limit ] if opts [ :limit ] query_params [ :page ] = opts [ :page ] if opts [ :page ] 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 ] post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'QueryClient#list_quick_picks' ) 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::ApmTraces::Models::QuickPickSummary>' ) end end
Returns a list of predefined quick pick queries intended to assist the user
to choose a query to run.
Returns a list of predefined quick pick queries intended to assist the user to choose a query to run .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type Array<{OCI::ApmTraces::Models::QuickPickSummary QuickPickSummary}>
A Response object with data of type Array< { OCI :: ApmTraces :: Models :: QuickPickSummary QuickPickSummary } >
Response
apm_domain_id
opts
:page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous response. (default to 1)
: page The page token representing the page at which to start retrieving results . This is usually retrieved from a previous response . ( default to 1 )
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_quick_picks API.
Click [ here ] to see an example of how to use list_quick_picks API .