lib/oci/compute_instance_agent/compute_instance_agent_client.rb
# Lists the execution details for Oracle Cloud Agent commands that run on the specified compute
# instance.
#
# @param [String] compartment_id The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
# @param [String] instance_id The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the instance.
# @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 Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
#   please provide the request ID.
#
# @option opts [String] :page 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 [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 1)
# @option opts [String] :sort_by The field to sort by. You can provide one sort order (`sortOrder`). Default order for
#   `TIMECREATED` is descending.
#
#   **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you
#   optionally filter by availability domain if the scope of the resource type is within a
#   single availability domain. If you call one of these \"List\" operations without specifying
#   an availability domain, the resources are grouped by availability domain, then sorted.
#
#   Allowed values are: TIMECREATED, DISPLAYNAME
# @option opts [String] :sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
#   is case sensitive.
#
#   Allowed values are: ASC, DESC
# @option opts [String] :lifecycle_state A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
# @return [Response] A Response object with data of type Array<{OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary InstanceAgentCommandExecutionSummary}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/computeinstanceagent/list_instance_agent_command_executions.rb.html) to see an example of how to use list_instance_agent_command_executions API.
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute
instance.
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance .
def list_instance_agent_command_executions(compartment_id, instance_id, opts = {})
      logger.debug 'Calling operation ComputeInstanceAgentClient#list_instance_agent_command_executions.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_instance_agent_command_executions." if compartment_id.nil?
      raise "Missing the required parameter 'instance_id' when calling list_instance_agent_command_executions." if instance_id.nil?
      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
      if opts[:lifecycle_state] && !OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary::LIFECYCLE_STATE_ENUM.'
      end
      path = '/instanceAgentCommandExecutions'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      query_params[:instanceId] = instance_id
      query_params[:page] = opts[:page] if opts[:page]
      query_params[:limit] = opts[:limit] if opts[:limit]
      query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
      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: 'ComputeInstanceAgentClient#list_instance_agent_command_executions') 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::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary>'
        )
      end
    end
def list_instance_agent_command_executions ( compartment_id , instance_id , opts = { } ) logger . debug 'Calling operation ComputeInstanceAgentClient#list_instance_agent_command_executions.' if logger raise "Missing the required parameter 'compartment_id' when calling list_instance_agent_command_executions." if compartment_id . nil? raise "Missing the required parameter 'instance_id' when calling list_instance_agent_command_executions." if instance_id . nil? 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 if opts [ :lifecycle_state ] && ! OCI :: ComputeInstanceAgent :: Models :: InstanceAgentCommandExecutionSummary :: LIFECYCLE_STATE_ENUM . include? ( opts [ :lifecycle_state ] ) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary::LIFECYCLE_STATE_ENUM.' end path = '/instanceAgentCommandExecutions' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id query_params [ :instanceId ] = instance_id query_params [ :page ] = opts [ :page ] if opts [ :page ] query_params [ :limit ] = opts [ :limit ] if opts [ :limit ] query_params [ :sortBy ] = opts [ :sort_by ] if opts [ :sort_by ] query_params [ :sortOrder ] = opts [ :sort_order ] if opts [ :sort_order ] 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 : 'ComputeInstanceAgentClient#list_instance_agent_command_executions' ) 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::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary>' ) end end
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute
instance.
Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance .
# 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::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionSummary InstanceAgentCommandExecutionSummary}>
A Response object with data of type Array< { OCI :: ComputeInstanceAgent :: Models :: InstanceAgentCommandExecutionSummary InstanceAgentCommandExecutionSummary } >
Response
compartment_id
instance_id
opts
:lifecycle_state A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
: lifecycle_state A filter to only return resources that match the given lifecycle state . The state value is case - insensitive .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_instance_agent_command_executions API.
Click [ here ] to see an example of how to use list_instance_agent_command_executions API .