lib/oci/management_agent/management_agent_client.rb
# Returns a list of Management Agent.
#
# @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] :plugin_name Filter to return only Management Agents having the particular Plugin installed.
# @option opts [String] :version Filter to return only Management Agents having the particular agent version.
# @option opts [String] :display_name Filter to return only Management Agents having the particular display name.
# @option opts [String] :lifecycle_state Filter to return only Management Agents in the particular lifecycle state.
# @option opts [String] :platform_type Filter to return only Management Agents having the particular platform type.
# @option opts [Integer] :limit The maximum number of items to return. (default to 10)
# @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'.
#   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 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::ManagementAgent::Models::ManagementAgentSummary ManagementAgentSummary}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementagent/list_management_agents.rb.html) to see an example of how to use list_management_agents API.
Returns a list of Management Agent.
Returns a list of Management Agent .
def list_management_agents(compartment_id, opts = {})
      logger.debug 'Calling operation ManagementAgentClient#list_management_agents.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_management_agents." if compartment_id.nil?
      if opts[:lifecycle_state] && !OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.'
      end
      if opts[:platform_type] && !OCI::ManagementAgent::Models::PLATFORM_TYPES_ENUM.include?(opts[:platform_type])
        raise 'Invalid value for "platform_type", must be one of the values in OCI::ManagementAgent::Models::PLATFORM_TYPES_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[timeCreated displayName].include?(opts[:sort_by])
        raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
      end
      path = '/managementAgents'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:pluginName] = opts[:plugin_name] if opts[:plugin_name]
      query_params[:version] = opts[:version] if opts[:version]
      query_params[:displayName] = opts[:display_name] if opts[:display_name]
      query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
      query_params[:platformType] = opts[:platform_type] if opts[:platform_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[: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_management_agents') 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::ManagementAgentSummary>'
        )
      end
    end
def list_management_agents ( compartment_id , opts = { } ) logger . debug 'Calling operation ManagementAgentClient#list_management_agents.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_agents." if compartment_id . nil? if opts [ :lifecycle_state ] && ! OCI :: ManagementAgent :: Models :: LIFECYCLE_STATES_ENUM . include? ( opts [ :lifecycle_state ] ) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ManagementAgent::Models::LIFECYCLE_STATES_ENUM.' end if opts [ :platform_type ] && ! OCI :: ManagementAgent :: Models :: PLATFORM_TYPES_ENUM . include? ( opts [ :platform_type ] ) raise 'Invalid value for "platform_type", must be one of the values in OCI::ManagementAgent::Models::PLATFORM_TYPES_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[ timeCreated displayName ] . include? ( opts [ :sort_by ] ) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/managementAgents' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :pluginName ] = opts [ :plugin_name ] if opts [ :plugin_name ] query_params [ :version ] = opts [ :version ] if opts [ :version ] query_params [ :displayName ] = opts [ :display_name ] if opts [ :display_name ] query_params [ :lifecycleState ] = opts [ :lifecycle_state ] if opts [ :lifecycle_state ] query_params [ :platformType ] = opts [ :platform_type ] if opts [ :platform_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 [ :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_management_agents' ) 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::ManagementAgentSummary>' ) end end
Returns a list of Management Agent.
Returns a list of Management Agent .
# 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::ManagementAgentSummary ManagementAgentSummary}>
A Response object with data of type Array< { OCI :: ManagementAgent :: Models :: ManagementAgentSummary ManagementAgentSummary } >
Response
compartment_id
opts
:opc_request_id The client request ID for tracing.
: opc_request_id The client request ID for tracing .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_management_agents API.
Click [ here ] to see an example of how to use list_management_agents API .