lib/oci/oce/oce_instance_client.rb
# Returns a list of OceInstances.
#
# @param [String] compartment_id The ID 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] :display_name A user-friendly name. Does not have to be unique, and it's changeable.
#
#   Example: `My new resource`
#
# @option opts [Integer] :limit The maximum number of items to return. (default to 50)
# @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'. (default to ASC)
#   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] :lifecycle_state Filter results on lifecycleState. (default to ACTIVE)
#   Allowed values are: CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED
# @option opts [String] :opc_request_id The client request ID for tracing.
# @return [Response] A Response object with data of type Array<{OCI::Oce::Models::OceInstanceSummary OceInstanceSummary}>
Returns a list of OceInstances.
Returns a list of OceInstances .
def list_oce_instances(compartment_id, opts = {})
      logger.debug 'Calling operation OceInstanceClient#list_oce_instances.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_oce_instances." if compartment_id.nil?
      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
      if opts[:lifecycle_state] && !%w[CREATING UPDATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.'
      end
      path = '/oceInstances'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:displayName] = opts[:display_name] if opts[:display_name]
      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]
      query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
      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: 'OceInstanceClient#list_oce_instances') 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::Oce::Models::OceInstanceSummary>'
        )
      end
    end
def list_oce_instances ( compartment_id , opts = { } ) logger . debug 'Calling operation OceInstanceClient#list_oce_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_oce_instances." if compartment_id . nil? 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 if opts [ :lifecycle_state ] && ! %w[ CREATING UPDATING ACTIVE DELETING DELETED FAILED ] . include? ( opts [ :lifecycle_state ] ) raise 'Invalid value for "lifecycle_state", must be one of CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED.' end path = '/oceInstances' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :displayName ] = opts [ :display_name ] if opts [ :display_name ] 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 ] query_params [ :lifecycleState ] = opts [ :lifecycle_state ] if opts [ :lifecycle_state ] 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 : 'OceInstanceClient#list_oce_instances' ) 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::Oce::Models::OceInstanceSummary>' ) end end
Returns a list of OceInstances.
Returns a list of OceInstances .
# 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::Oce::Models::OceInstanceSummary OceInstanceSummary}>
A Response object with data of type Array< { OCI :: Oce :: Models :: OceInstanceSummary OceInstanceSummary } >
Response
compartment_id
<not_specific>
opts
:opc_request_id The client request ID for tracing.
: opc_request_id The client request ID for tracing .
<not_specific>
opts the optional parameters
opts the optional parameters