lib/oci/network_load_balancer/network_load_balancer_client.rb
# Lists all backend sets associated with a given network load balancer.
# @param [String] network_load_balancer_id The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the network load balancer to update.
# @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 The unique Oracle-assigned identifier for the request. If you must contact Oracle about a
#   particular request, then provide the request identifier.
#
# @option opts [String] :if_none_match The system returns the requested resource, with a 200 status, only if the resource has no etag
#   matching the one specified. If the condition fails for the GET and HEAD methods, then the system returns the
#   HTTP status code `304 (Not Modified)`.
#
#   Example: `example-etag`
#    (default to )
# @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).
#
# @option opts [String] :sort_order The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)
# @return [Response] A Response object with data of type {OCI::NetworkLoadBalancer::Models::BackendSetCollection BackendSetCollection}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/networkloadbalancer/list_backend_sets.rb.html) to see an example of how to use list_backend_sets API.
Lists all backend sets associated with a given network load balancer.
Lists all backend sets associated with a given network load balancer .
def list_backend_sets(network_load_balancer_id, opts = {})
      logger.debug 'Calling operation NetworkLoadBalancerClient#list_backend_sets.' if logger
      raise "Missing the required parameter 'network_load_balancer_id' when calling list_backend_sets." if network_load_balancer_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
      raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI::Internal::Util.blank_string?(network_load_balancer_id)
      path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets'.sub('{networkLoadBalancerId}', network_load_balancer_id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      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]
      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]
      header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkLoadBalancerClient#list_backend_sets') 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::BackendSetCollection'
        )
      end
    end
def list_backend_sets ( network_load_balancer_id , opts = { } ) logger . debug 'Calling operation NetworkLoadBalancerClient#list_backend_sets.' if logger raise "Missing the required parameter 'network_load_balancer_id' when calling list_backend_sets." if network_load_balancer_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 raise "Parameter value for 'network_load_balancer_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( network_load_balancer_id ) path = '/networkLoadBalancers/{networkLoadBalancerId}/backendSets' . sub ( '{networkLoadBalancerId}' , network_load_balancer_id . to_s ) operation_signing_strategy = :standard query_params = { } 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 ] 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 ] header_params [ :' if-none-match ' ] = opts [ :if_none_match ] if opts [ :if_none_match ] post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'NetworkLoadBalancerClient#list_backend_sets' ) 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::BackendSetCollection' ) end end
Lists all backend sets associated with a given network load balancer.
Lists all backend sets associated with a given network load balancer .
# 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::BackendSetCollection BackendSetCollection}
A Response object with data of type { OCI :: NetworkLoadBalancer :: Models :: BackendSetCollection BackendSetCollection }
Response
network_load_balancer_id
opts
:sort_order The sort order to use, either 'asc' (ascending) or 'desc' (descending). (default to ASC)
: sort_order The sort order to use either ' asc ' ( ascending ) or ' desc ' ( descending ) . ( default to ASC )
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_backend_sets API.
Click [ here ] to see an example of how to use list_backend_sets API .