lib/oci/logging/logging_management_client.rb
def list_unified_agent_configurations(compartment_id, opts = {})
      logger.debug 'Calling operation LoggingManagementClient#list_unified_agent_configurations.' if logger

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

      if opts[:lifecycle_state] && !OCI::Logging::Models::LOG_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Logging::Models::LOG_LIFECYCLE_STATE_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

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

      path = '/unifiedAgentConfigurations'
      operation_signing_strategy = :standard

      # rubocop:disable Style/NegatedIf
      # Query Params
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:logId] = opts[:log_id] if opts[:log_id]
      query_params[:isCompartmentIdInSubtree] = opts[:is_compartment_id_in_subtree] if !opts[:is_compartment_id_in_subtree].nil?
      query_params[:groupId] = opts[:group_id] if opts[:group_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[:sortBy] = opts[:sort_by] if opts[:sort_by]
      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

      # 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: 'LoggingManagementClient#list_unified_agent_configurations') 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::Logging::Models::UnifiedAgentConfigurationCollection'
        )
      end
      # rubocop:enable Metrics/BlockLength
    end
# Lists all unified agent configurations in the specified compartment.
# @param [String] compartment_id Compartment OCID to list resources in. See compartmentIdInSubtree
#        for nested compartments traversal.
#
# @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] :log_id Custom log OCID to list resources with the log as destination.
#
# @option opts [BOOLEAN] :is_compartment_id_in_subtree Specifies whether or not nested compartments should be traversed. Defaults to false. (default to false)
# @option opts [String] :group_id The OCID of a group or a dynamic group.
# @option opts [String] :display_name Resource name
# @option opts [String] :lifecycle_state Lifecycle state of the log object
# @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
#    (default to 100)
# @option opts [String] :page For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.
#   For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
#
# @option opts [String] :sort_by The field to sort by (one column only). Default sort order is
#   ascending exception of `timeCreated` and `timeLastModified` columns (descending).
#
#   Allowed values are: timeCreated, displayName
# @option opts [String] :sort_order The sort order to use, whether 'asc' or 'desc'.
#
#   Allowed values are: ASC, DESC
# @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.
#
# @return [Response] A Response object with data of type {OCI::Logging::Models::UnifiedAgentConfigurationCollection UnifiedAgentConfigurationCollection}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/logging/list_unified_agent_configurations.rb.html) to see an example of how to use list_unified_agent_configurations API.
Lists all unified agent configurations in the specified compartment.
Lists all unified agent configurations in the specified compartment .
def list_unified_agent_configurations(compartment_id, opts = {})
      logger.debug 'Calling operation LoggingManagementClient#list_unified_agent_configurations.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_unified_agent_configurations." if compartment_id.nil?
      if opts[:lifecycle_state] && !OCI::Logging::Models::LOG_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Logging::Models::LOG_LIFECYCLE_STATE_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
      if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
        raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
      end
      path = '/unifiedAgentConfigurations'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:logId] = opts[:log_id] if opts[:log_id]
      query_params[:isCompartmentIdInSubtree] = opts[:is_compartment_id_in_subtree] if !opts[:is_compartment_id_in_subtree].nil?
      query_params[:groupId] = opts[:group_id] if opts[:group_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[:sortBy] = opts[:sort_by] if opts[:sort_by]
      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
      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: 'LoggingManagementClient#list_unified_agent_configurations') 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::Logging::Models::UnifiedAgentConfigurationCollection'
        )
      end
    end
def list_unified_agent_configurations ( compartment_id , opts = { } ) logger . debug 'Calling operation LoggingManagementClient#list_unified_agent_configurations.' if logger raise "Missing the required parameter 'compartment_id' when calling list_unified_agent_configurations." if compartment_id . nil? if opts [ :lifecycle_state ] && ! OCI :: Logging :: Models :: LOG_LIFECYCLE_STATE_ENUM . include? ( opts [ :lifecycle_state ] ) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Logging::Models::LOG_LIFECYCLE_STATE_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 if opts [ :sort_order ] && ! %w[ ASC DESC ] . include? ( opts [ :sort_order ] ) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/unifiedAgentConfigurations' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :logId ] = opts [ :log_id ] if opts [ :log_id ] query_params [ :isCompartmentIdInSubtree ] = opts [ :is_compartment_id_in_subtree ] if ! opts [ :is_compartment_id_in_subtree ] . nil? query_params [ :groupId ] = opts [ :group_id ] if opts [ :group_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 [ :sortBy ] = opts [ :sort_by ] if opts [ :sort_by ] query_params [ :sortOrder ] = opts [ :sort_order ] if opts [ :sort_order ] 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 : 'LoggingManagementClient#list_unified_agent_configurations' ) 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::Logging::Models::UnifiedAgentConfigurationCollection' ) end end
Lists all unified agent configurations in the specified compartment.
Lists all unified agent configurations in the specified 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 {OCI::Logging::Models::UnifiedAgentConfigurationCollection UnifiedAgentConfigurationCollection}
A Response object with data of type { OCI :: Logging :: Models :: UnifiedAgentConfigurationCollection UnifiedAgentConfigurationCollection }
Response
compartment_id
opts
: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.
: 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 .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_unified_agent_configurations API.
Click [ here ] to see an example of how to use list_unified_agent_configurations API .