lib/oci/network_load_balancer/network_load_balancer_client.rb
def list_network_load_balancer_healths(compartment_id, opts = {})
      logger.debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancer_healths.' if logger

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

      if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
        raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_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 = '/networkLoadBalancers/health'
      operation_signing_strategy = :standard

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

      # 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: 'NetworkLoadBalancerClient#list_network_load_balancer_healths') 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::NetworkLoadBalancer::Models::NetworkLoadBalancerHealthCollection'
        )
      end
      # rubocop:enable Metrics/BlockLength
    end
# Lists the summary health statuses for all network load balancers in the specified compartment.
# @param [String] compartment_id The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list.
#
# @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] :sort_order The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)
# @option opts [String] :sort_by The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending.
#   The default order for displayName is ascending. If no value is specified, then timeCreated is the default.
#    (default to timeCreated)
#   Allowed values are: timeCreated, displayName
# @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
#   particular request, then provide the request identifier.
#
# @option opts [Integer] :limit For list pagination. The maximum number of results per page or items to return, in a paginated \"List\" call.
#   For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
#    (default to 10)
# @option opts [String] :page The page token representing the page from which to start retrieving results.
#   For list pagination. The value of the `opc-next-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).
#
# @return [Response] A Response object with data of type {OCI::NetworkLoadBalancer::Models::NetworkLoadBalancerHealthCollection NetworkLoadBalancerHealthCollection}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/networkloadbalancer/list_network_load_balancer_healths.rb.html) to see an example of how to use list_network_load_balancer_healths API.
Lists the summary health statuses for all network load balancers in the specified compartment.
Lists the summary health statuses for all network load balancers in the specified compartment .
def list_network_load_balancer_healths(compartment_id, opts = {})
      logger.debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancer_healths.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_network_load_balancer_healths." if compartment_id.nil?
      if opts[:sort_order] && !OCI::NetworkLoadBalancer::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
        raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_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 = '/networkLoadBalancers/health'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
      query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
      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: 'NetworkLoadBalancerClient#list_network_load_balancer_healths') 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::NetworkLoadBalancer::Models::NetworkLoadBalancerHealthCollection'
        )
      end
    end
def list_network_load_balancer_healths ( compartment_id , opts = { } ) logger . debug 'Calling operation NetworkLoadBalancerClient#list_network_load_balancer_healths.' if logger raise "Missing the required parameter 'compartment_id' when calling list_network_load_balancer_healths." if compartment_id . nil? if opts [ :sort_order ] && ! OCI :: NetworkLoadBalancer :: Models :: SORT_ORDER_ENUM . include? ( opts [ :sort_order ] ) raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkLoadBalancer::Models::SORT_ORDER_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 = '/networkLoadBalancers/health' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :sortOrder ] = opts [ :sort_order ] if opts [ :sort_order ] query_params [ :sortBy ] = opts [ :sort_by ] if opts [ :sort_by ] 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 : 'NetworkLoadBalancerClient#list_network_load_balancer_healths' ) 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::NetworkLoadBalancer::Models::NetworkLoadBalancerHealthCollection' ) end end
Lists the summary health statuses for all network load balancers in the specified compartment.
Lists the summary health statuses for all network load balancers 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::NetworkLoadBalancer::Models::NetworkLoadBalancerHealthCollection NetworkLoadBalancerHealthCollection}
A Response object with data of type { OCI :: NetworkLoadBalancer :: Models :: NetworkLoadBalancerHealthCollection NetworkLoadBalancerHealthCollection }
Response
compartment_id
opts
:page The page token representing the page from which to start retrieving results. For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination].
: page The page token representing the page from which to start retrieving results . For list pagination . The value of the ` opc - next - page ` response header from the previous \ " List \ " call . For important details about how pagination works see [ List Pagination ] .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_network_load_balancer_healths API.
Click [ here ] to see an example of how to use list_network_load_balancer_healths API .