Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

getState task

Returns the current state of a task.

Syntax

getState task --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

or

getState task -n object_name [-o output_file] [-l state_properties]

Parameters

object_name

The name of a task:

resumeAllSpaceConsumingTasks
stopAllSpaceConsumingTasks
output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

One or more of these state properties:endTime, startTime, or status. Separate multiple properties with commas. All state properties are returned by default.

Example

This example shows that resumeAllSpaceConsumingTasks is currently scheduled. The other states are not set.

SES>getState task --NAME=resumeAllSpaceConsumingTasks
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>task</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>resumeAllSpaceConsumingTasks</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>SCHEDULED</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>