lib/oci/apigateway/gateway_client.rb
def list_gateways(compartment_id, opts = {})
      logger.debug 'Calling operation GatewayClient#list_gateways.' if logger

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

      if opts[:lifecycle_state] && !OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_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 = '/gateways'
      operation_signing_strategy = :standard

      # rubocop:disable Style/NegatedIf
      # Query Params
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:certificateId] = opts[:certificate_id] if opts[:certificate_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[:sortOrder] = opts[:sort_order] if opts[:sort_order]
      query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

      # 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: 'GatewayClient#list_gateways') 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::Apigateway::Models::GatewayCollection'
        )
      end
      # rubocop:enable Metrics/BlockLength
    end
# Returns a list of gateways.
#
# @param [String] compartment_id The ocid of the compartment in which to list resources.
# @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] :certificate_id Filter gateways by the certificate ocid. (default to null)
# @option opts [String] :display_name A user-friendly name. Does not have to be unique, and it's changeable.
#
#   Example: `My new resource`
#    (default to null)
# @option opts [String] :lifecycle_state A filter to return only resources that match the given lifecycle state.
#
#   Example: `SUCCEEDED`
#    (default to null)
# @option opts [Integer] :limit The maximum number of items to return. (default to 100)
# @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. (default to null)
# @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value. (default to ASC)
#   Allowed values are: ASC, DESC
# @option opts [String] :sort_by The field to sort by. You can provide one sort order (`sortOrder`).
#   Default order for `timeCreated` is descending. Default order for
#   `displayName` is ascending. The `displayName` sort order is case
#   sensitive.
#    (default to timeCreated)
#   Allowed values are: timeCreated, displayName
# @option opts [String] :opc_request_id The client request id for tracing. (default to null)
# @return [Response] A Response object with data of type {OCI::Apigateway::Models::GatewayCollection GatewayCollection}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apigateway/list_gateways.rb.html) to see an example of how to use list_gateways API.
Returns a list of gateways.
Returns a list of gateways .
def list_gateways(compartment_id, opts = {})
      logger.debug 'Calling operation GatewayClient#list_gateways.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_gateways." if compartment_id.nil?
      if opts[:lifecycle_state] && !OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_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 = '/gateways'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:certificateId] = opts[:certificate_id] if opts[:certificate_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[: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: 'GatewayClient#list_gateways') 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::Apigateway::Models::GatewayCollection'
        )
      end
    end
def list_gateways ( compartment_id , opts = { } ) logger . debug 'Calling operation GatewayClient#list_gateways.' if logger raise "Missing the required parameter 'compartment_id' when calling list_gateways." if compartment_id . nil? if opts [ :lifecycle_state ] && ! OCI :: Apigateway :: Models :: Gateway :: LIFECYCLE_STATE_ENUM . include? ( opts [ :lifecycle_state ] ) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Gateway::LIFECYCLE_STATE_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 = '/gateways' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :certificateId ] = opts [ :certificate_id ] if opts [ :certificate_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 [ :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 : 'GatewayClient#list_gateways' ) 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::Apigateway::Models::GatewayCollection' ) end end
Returns a list of gateways.
Returns a list of gateways .
# 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::Apigateway::Models::GatewayCollection GatewayCollection}
A Response object with data of type { OCI :: Apigateway :: Models :: GatewayCollection GatewayCollection }
Response
compartment_id
opts
:opc_request_id The client request id for tracing. (default to null)
: opc_request_id The client request id for tracing . ( default to null )
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_gateways API.
Click [ here ] to see an example of how to use list_gateways API .