lib/oci/management_agent/management_agent_client.rb
# Lists the work requests in a compartment.
#
# @param [String] compartment_id The ID of the compartment from which the Management Agents to be listed.
# @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] :agent_id The ManagementAgentID of the agent from which the Management Agents to be filtered.
# @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 10)
# @option opts [String] :status The OperationStatus of the workRequest
# @option opts [DateTime] :time_created_greater_than_or_equal_to Filter for items with timeCreated greater or equal to provided value.
#   given `timeCreatedGreaterThanOrEqualTo` to the current time, in \"YYYY-MM-ddThh:mmZ\" format with a
#   Z offset, as defined by RFC 3339.
#
# @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'.
#   Allowed values are: ASC, DESC
# @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default.
#    (default to timeAccepted)
#   Allowed values are: timeAccepted
# @return [Response] A Response object with data of type Array<{OCI::ManagementAgent::Models::WorkRequestSummary WorkRequestSummary}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementagent/list_work_requests.rb.html) to see an example of how to use list_work_requests API.
Lists the work requests in a compartment.
Lists the work requests in a compartment .
def list_work_requests(compartment_id, opts = {})
      logger.debug 'Calling operation ManagementAgentClient#list_work_requests.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?
      if opts[:status] && !OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.include?(opts[:status])
        raise 'Invalid value for "status", must be one of the values in OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.'
      end
      if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
        raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
      end
      if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
        raise 'Invalid value for "sort_by", must be one of timeAccepted.'
      end
      path = '/workRequests'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:agentId] = opts[:agent_id] if opts[:agent_id]
      query_params[:page] = opts[:page] if opts[:page]
      query_params[:limit] = opts[:limit] if opts[:limit]
      query_params[:status] = opts[:status] if opts[:status]
      query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to]
      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
      query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
      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: 'ManagementAgentClient#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::ManagementAgent::Models::WorkRequestSummary>'
        )
      end
    end
def list_work_requests ( compartment_id , opts = { } ) logger . debug 'Calling operation ManagementAgentClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id . nil? if opts [ :status ] && ! OCI :: ManagementAgent :: Models :: OPERATION_STATUS_ENUM . include? ( opts [ :status ] ) raise 'Invalid value for "status", must be one of the values in OCI::ManagementAgent::Models::OPERATION_STATUS_ENUM.' end if opts [ :sort_order ] && ! %w[ ASC DESC ] . include? ( opts [ :sort_order ] ) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts [ :sort_by ] && ! %w[ timeAccepted ] . include? ( opts [ :sort_by ] ) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end path = '/workRequests' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :agentId ] = opts [ :agent_id ] if opts [ :agent_id ] query_params [ :page ] = opts [ :page ] if opts [ :page ] query_params [ :limit ] = opts [ :limit ] if opts [ :limit ] query_params [ :status ] = opts [ :status ] if opts [ :status ] query_params [ :timeCreatedGreaterThanOrEqualTo ] = opts [ :time_created_greater_than_or_equal_to ] if opts [ :time_created_greater_than_or_equal_to ] query_params [ :sortOrder ] = opts [ :sort_order ] if opts [ :sort_order ] query_params [ :sortBy ] = opts [ :sort_by ] if opts [ :sort_by ] 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 : 'ManagementAgentClient#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::ManagementAgent::Models::WorkRequestSummary>' ) end end
Lists the work requests in a compartment.
Lists the work requests in a compartment .
# 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::ManagementAgent::Models::WorkRequestSummary WorkRequestSummary}>
A Response object with data of type Array< { OCI :: ManagementAgent :: Models :: WorkRequestSummary WorkRequestSummary } >
Response
compartment_id
opts
:sort_by The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default. (default to timeAccepted) Allowed values are: timeAccepted
: sort_by The field to sort by . Only one sort order may be provided . Default order for timeAccepted is descending . If no value is specified timeAccepted is default . ( default to timeAccepted ) Allowed values are : timeAccepted
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_work_requests API.
Click [ here ] to see an example of how to use list_work_requests API .