Google Search Appliance Administrative API Developers Guide: Java - Manual (Page 42)

Google Search Appliance: Administrative API Developer’s Guide: Java 42
Retrieving Search Status
Retrieve the current search appliance search status as follows:
GsaEntry myEntry = myClient.getEntry("status", "servingStatus");
System.out.println("Queries Per Minute: " +
myEntry.getGsaContent("queriesPerMinute"));
Reports
The sections that follow describe how to configure the Reports features of the Admin Console:
• “Search Reports” on page 42
• “Search Logs” on page 45
Search Reports
Generate, update, and delete search reports using the searchReport feed.
Search report entry properties:
Property Description
collectionName (Write only) The collection name—only use to create a search report.
diagnosticTerms Terms to exclude when running scripts that create diagnostic data from test
queries. All the specified terms in a search query are removed from the
report. Use commas to separate multiple terms.
Entry Name Search_Report_Name@Collection_Name
isFinal (Read only) Indicates if a search report contains a final result. If so, it means
the last update date is later than the reportDate.
reportContent (Read only) The search report content. Only use for requests to get search
report content when the content is ready.
reportCreationDate (Read only) The creation date of a search report.
reportDate The dates of each query that is collected in the search report.
reportName (Write only) The report name—only use to create a search report.
reportState (Read only) The status of a search report:
• 0: The search report is initializing.
• 1: The search report is generating.
• 2: The search report is complete.
• 3: A non-final complete report is generating
• 4: The last report generation failed.