|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.novell.sentinel.client.bean.SentinelBean com.novell.db.object.bean.EventSearchBean
public class EventSearchBean
An automatically-generated "bean" class for the Sentinel data object type 'event-search
'.
SentinelBean
.
SentinelBean
,
BeanTransporter
Nested Class Summary | |
---|---|
static class |
EventSearchBean.StatusCodeType
An enumerated type representing values for the field ' status '. |
static class |
EventSearchBean.TypeType
An enumerated type representing values for the field ' type '. |
Field Summary | |
---|---|
static String |
AGGREGATINGOBJECT
The "bean name" of the Sentinel data object field 'AggregatingObject'. |
static String |
AVAILABLECOUNT
The "bean name" of the Sentinel data object field 'AvailableCount'. |
static String |
DATERANGEEND
The "bean name" of the Sentinel data object field 'DateRangeEnd'. |
static String |
DATERANGESTART
The "bean name" of the Sentinel data object field 'DateRangeStart'. |
static String |
FIELDS
The "bean name" of the Sentinel data object field 'Fields'. |
static String |
FILTER
The "bean name" of the Sentinel data object field 'Filter'. |
static String |
FOUNDCOUNT
The "bean name" of the Sentinel data object field 'FoundCount'. |
static String |
INITIATINGHOSTNAME
The "bean name" of the Sentinel data object field 'InitiatingHostName'. |
static String |
INITIATINGIPADDRESS
The "bean name" of the Sentinel data object field 'InitiatingIPAddress'. |
static String |
INITIATINGUSERNAME
The "bean name" of the Sentinel data object field 'InitiatingUserName'. |
static String |
JOBENDTIME
The "bean name" of the Sentinel data object field 'JobEndTime'. |
static String |
JOBSTARTTIME
The "bean name" of the Sentinel data object field 'JobStartTime'. |
static String |
LASTACCESSEDTIME
The "bean name" of the Sentinel data object field 'LastAccessedTime'. |
static String |
MAXIMUMRESULTS
The "bean name" of the Sentinel data object field 'MaximumResults'. |
static String |
OWNER
The "bean name" of the Sentinel data object field 'Owner'. |
static String |
PAGESIZE
The "bean name" of the Sentinel data object field 'PageSize'. |
static String |
RESULTS
The "bean name" of the Sentinel data object field 'Results'. |
static String |
STATUSCODE
The "bean name" of the Sentinel data object field 'StatusCode'. |
static String |
TYPE
The "bean name" of the Sentinel data object field 'Type'. |
Constructor Summary | |
---|---|
|
EventSearchBean()
Construct an instance of the bean class. |
protected |
EventSearchBean(BeanMetaData<? extends SentinelBean> metadata)
Constructor for use by derived classes. |
Method Summary | |
---|---|
void |
addToFields(String value)
Add a value to the collection field ' fields '. |
void |
clearAggregatingObjectLink()
Clear any current URL value for the ' aggregate-obj ' field in the bean. |
void |
clearDateRangeEnd()
Clear any current value for the ' end ' field in the bean. |
void |
clearDateRangeStart()
Clear any current value for the ' start ' field in the bean. |
void |
clearFields()
Clear any current value for the ' fields ' field in the bean. |
void |
clearFilter()
Clear any current value for the ' filter ' field in the bean. |
void |
clearInitiatingHostName()
Clear any current value for the ' InitiatingHostName ' field in the bean. |
void |
clearInitiatingIPAddress()
Clear any current value for the ' ip ' field in the bean. |
void |
clearInitiatingUserName()
Clear any current value for the ' init-user ' field in the bean. |
void |
clearJobEndTime()
Clear any current value for the ' job-end ' field in the bean. |
void |
clearJobStartTime()
Clear any current value for the ' job-start ' field in the bean. |
void |
clearLastAccessedTime()
Clear any current value for the ' last-accessed ' field in the bean. |
void |
clearMaximumResults()
Clear any current value for the ' max-results ' field in the bean. |
void |
clearPageSize()
Clear any current value for the ' pgsize ' field in the bean. |
void |
clearType()
Clear any current value for the ' type ' field in the bean. |
EventSearchBean |
clone()
Create a duplicate of this bean instance, including all field values. |
String |
getAggregatingObjectLink()
Get the URL for the ' aggregate-obj ' field. |
long |
getAvailableCount()
Get the value for the ' avail ' field. |
static BeanMetaData<? extends EventSearchBean> |
getBeanMetaData()
Get the metadata class instance for this type. |
Date |
getDateRangeEnd()
Get the value for the ' end ' field. |
Date |
getDateRangeStart()
Get the value for the ' start ' field. |
Collection<String> |
getFields()
Get the value for the ' fields ' field. |
String |
getFilter()
Get the value for the ' filter ' field. |
long |
getFoundCount()
Get the value for the ' found ' field. |
String |
getInitiatingHostName()
Get the value for the ' InitiatingHostName ' field. |
String |
getInitiatingIPAddress()
Get the value for the ' ip ' field. |
String |
getInitiatingUserName()
Get the value for the ' init-user ' field. |
Date |
getJobEndTime()
Get the value for the ' job-end ' field. |
Date |
getJobStartTime()
Get the value for the ' job-start ' field. |
Date |
getLastAccessedTime()
Get the value for the ' last-accessed ' field. |
long |
getMaximumResults()
Get the value for the ' max-results ' field. |
String |
getOwnerLink()
Get the URL for the ' owner ' field. |
int |
getPageSize()
Get the value for the ' pgsize ' field. |
String |
getResultsLink()
Get the URL for the ' results ' field. |
EventSearchBean.StatusCodeType |
getStatusCode()
Get the value for the ' status ' field. |
EventSearchBean.TypeType |
getType()
Get the value for the ' type ' field. |
boolean |
isAggregatingObjectLinkClear()
Get whether the value for the ' aggregate-obj ' URL field is clear or
not. |
boolean |
isAggregatingObjectLinkNull()
Get whether the ' aggregate-obj ' URL field has been set to Null
or not. |
boolean |
isAvailableCountClear()
Get whether the value for the ' avail ' field is clear or not. |
boolean |
isAvailableCountNull()
Get whether the ' avail ' field has been set to Null or not. |
boolean |
isDateRangeEndClear()
Get whether the value for the ' end ' field is clear or not. |
boolean |
isDateRangeEndNull()
Get whether the ' end ' field has been set to Null or not. |
boolean |
isDateRangeStartClear()
Get whether the value for the ' start ' field is clear or not. |
boolean |
isDateRangeStartNull()
Get whether the ' start ' field has been set to Null or not. |
boolean |
isFieldsClear()
Get whether the value for the ' fields ' field is clear or not. |
boolean |
isFieldsNull()
Get whether the ' fields ' field has been set to Null or not. |
boolean |
isFilterClear()
Get whether the value for the ' filter ' field is clear or not. |
boolean |
isFilterNull()
Get whether the ' filter ' field has been set to Null or not. |
boolean |
isFoundCountClear()
Get whether the value for the ' found ' field is clear or not. |
boolean |
isFoundCountNull()
Get whether the ' found ' field has been set to Null or not. |
boolean |
isInitiatingHostNameClear()
Get whether the value for the ' InitiatingHostName ' field is clear or
not. |
boolean |
isInitiatingHostNameNull()
Get whether the ' InitiatingHostName ' field has been set to Null
or not. |
boolean |
isInitiatingIPAddressClear()
Get whether the value for the ' ip ' field is clear or not. |
boolean |
isInitiatingIPAddressNull()
Get whether the ' ip ' field has been set to Null or not. |
boolean |
isInitiatingUserNameClear()
Get whether the value for the ' init-user ' field is clear or not. |
boolean |
isInitiatingUserNameNull()
Get whether the ' init-user ' field has been set to Null or not. |
boolean |
isJobEndTimeClear()
Get whether the value for the ' job-end ' field is clear or not. |
boolean |
isJobEndTimeNull()
Get whether the ' job-end ' field has been set to Null or not. |
boolean |
isJobStartTimeClear()
Get whether the value for the ' job-start ' field is clear or not. |
boolean |
isJobStartTimeNull()
Get whether the ' job-start ' field has been set to Null or not. |
boolean |
isLastAccessedTimeClear()
Get whether the value for the ' last-accessed ' field is clear or not. |
boolean |
isLastAccessedTimeNull()
Get whether the ' last-accessed ' field has been set to Null or
not. |
boolean |
isMaximumResultsClear()
Get whether the value for the ' max-results ' field is clear or not. |
boolean |
isMaximumResultsNull()
Get whether the ' max-results ' field has been set to Null or not. |
boolean |
isOwnerLinkClear()
Get whether the value for the ' owner ' URL field is clear or not. |
boolean |
isOwnerLinkNull()
Get whether the ' owner ' URL field has been set to Null or not. |
boolean |
isPageSizeClear()
Get whether the value for the ' pgsize ' field is clear or not. |
boolean |
isPageSizeNull()
Get whether the ' pgsize ' field has been set to Null or not. |
boolean |
isResultsLinkClear()
Get whether the value for the ' results ' URL field is clear or not. |
boolean |
isResultsLinkNull()
Get whether the ' results ' URL field has been set to Null or not. |
boolean |
isStatusCodeClear()
Get whether the value for the ' status ' field is clear or not. |
boolean |
isStatusCodeNull()
Get whether the ' status ' field has been set to Null or not. |
boolean |
isTypeClear()
Get whether the value for the ' type ' field is clear or not. |
boolean |
isTypeNull()
Get whether the ' type ' field has been set to Null or not. |
void |
setAggregatingObjectLink(String aggregatingObject)
Set a URL value for the ' aggregate-obj ' field. |
void |
setAggregatingObjectLinkNull()
Set to Null any current URL value for the ' aggregate-obj ' field
in the bean. |
void |
setDateRangeEnd(Date dateRangeEnd)
Set the value for the ' end ' field. |
void |
setDateRangeEndNull()
Set to Null any current value for the ' end ' field in the bean. |
void |
setDateRangeStart(Date dateRangeStart)
Set the value for the ' start ' field. |
void |
setDateRangeStartNull()
Set to Null any current value for the ' start ' field in the bean. |
void |
setFields(Collection<? extends String> fields)
Set the value for the ' fields ' field. |
void |
setFieldsNull()
Set to Null any current value for the ' fields ' field in the bean. |
void |
setFilter(String filter)
Set the value for the ' filter ' field. |
void |
setFilterNull()
Set to Null any current value for the ' filter ' field in the bean. |
void |
setInitiatingHostName(String initiatingHostName)
Set the value for the ' InitiatingHostName ' field. |
void |
setInitiatingHostNameNull()
Set to Null any current value for the ' InitiatingHostName ' field
in the bean. |
void |
setInitiatingIPAddress(String initiatingIPAddress)
Set the value for the ' ip ' field. |
void |
setInitiatingIPAddressNull()
Set to Null any current value for the ' ip ' field in the bean. |
void |
setInitiatingUserName(String initiatingUserName)
Set the value for the ' init-user ' field. |
void |
setInitiatingUserNameNull()
Set to Null any current value for the ' init-user ' field in the
bean. |
void |
setJobEndTime(Date jobEndTime)
Set the value for the ' job-end ' field. |
void |
setJobEndTimeNull()
Set to Null any current value for the ' job-end ' field in the
bean. |
void |
setJobStartTime(Date jobStartTime)
Set the value for the ' job-start ' field. |
void |
setJobStartTimeNull()
Set to Null any current value for the ' job-start ' field in the
bean. |
void |
setLastAccessedTime(Date lastAccessedTime)
Set the value for the ' last-accessed ' field. |
void |
setLastAccessedTimeNull()
Set to Null any current value for the ' last-accessed ' field in
the bean. |
void |
setMaximumResults(long maximumResults)
Set the value for the ' max-results ' field. |
void |
setMaximumResultsNull()
Set to Null any current value for the ' max-results ' field in
the bean. |
void |
setPageSize(int pageSize)
Set the value for the ' pgsize ' field. |
void |
setPageSizeNull()
Set to Null any current value for the ' pgsize ' field in the bean. |
void |
setType(EventSearchBean.TypeType type)
Set the value for the ' type ' field. |
void |
setTypeNull()
Set to Null any current value for the ' type ' field in the bean. |
Methods inherited from class com.novell.sentinel.client.bean.SentinelBean |
---|
clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String AVAILABLECOUNT
""avail""
.
The description of the 'avail
' field is:
"The available count number indicates the total number of events that are currently
available in the results that can be obtained from the search job."
public static final String MAXIMUMRESULTS
""max-results""
.
The description of the 'max-results
' field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
public static final String PAGESIZE
""pgsize""
.
The description of the 'pgsize
' field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
public static final String INITIATINGUSERNAME
""init-user""
.
The description of the 'init-user
' field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
public static final String AGGREGATINGOBJECT
""aggregate-obj""
.
The description of the 'aggregate-obj
' field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
public static final String INITIATINGIPADDRESS
""ip""
.
The description of the 'ip
' field is:
"The IP address of the system from which the search job was initiated."
public static final String OWNER
""owner""
.
The description of the 'owner
' field is:
"The owner link is a URL that is used to obtain the user object of the user which
started the search job. The link will be empty for SYSTEM search jobs."
public static final String FILTER
""filter""
.
The description of the 'filter
' field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
public static final String LASTACCESSEDTIME
""last-accessed""
.
The description of the 'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
public static final String DATERANGEEND
""end""
.
The description of the 'end
' field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
public static final String FOUNDCOUNT
""found""
.
The description of the 'found
' field is:
"The found count number indicates the total number of events found that match the
search job parameters."
public static final String JOBSTARTTIME
""job-start""
.
The description of the 'job-start
' field is:
"The job start time is the time the search job started running."
public static final String FIELDS
""fields""
.
The description of the 'fields
' field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
public static final String INITIATINGHOSTNAME
""InitiatingHostName""
.
The description of the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
public static final String STATUSCODE
""status""
.
The description of the 'status
' field is:
"The status of a search job reflects the search job's current state. Values are:
0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable),
5 (Canceled), 6 (Access Denied)."
public static final String RESULTS
""results""
.
The description of the 'results
' field is:
"The results link is a URL that is used to obtain the first page of the results of
the search job."
public static final String JOBENDTIME
""job-end""
.
The description of the 'job-end
' field is:
"The job end time is the time the search job finished."
public static final String DATERANGESTART
""start""
.
The description of the 'start
' field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
public static final String TYPE
""type""
.
The description of the 'type
' field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
Constructor Detail |
---|
public EventSearchBean()
protected EventSearchBean(BeanMetaData<? extends SentinelBean> metadata)
metadata
- The metadata instance for the derived bean class. Normally this constructor
will only be called by generated code.Method Detail |
---|
public String getInitiatingHostName()
InitiatingHostName
' field. The description of
the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
null
).INITIATINGHOSTNAME
public boolean isInitiatingHostNameNull()
InitiatingHostName
' field has been set to Null
or not. The description of the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setInitiatingHostNameNull()
,
INITIATINGHOSTNAME
public boolean isInitiatingHostNameClear()
InitiatingHostName
' field is clear or
not. The description of the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearInitiatingHostName()
,
INITIATINGHOSTNAME
public void setInitiatingHostName(String initiatingHostName)
InitiatingHostName
' field. The description of
the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
initiatingHostName
- Value to setINITIATINGHOSTNAME
public void clearInitiatingHostName()
InitiatingHostName
' field in the bean.
The description of the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setInitiatingHostNameNull()
method to clear the server's value.
See the description of cleared
values.
INITIATINGHOSTNAME
public void setInitiatingHostNameNull()
InitiatingHostName
' field
in the bean. The description of the 'InitiatingHostName
' field is:
"The hostname of the system that initiated the search job, if available."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearInitiatingHostName()
method to avoid clearing the server's
value.
See the description of Null
values.
INITIATINGHOSTNAME
public EventSearchBean.StatusCodeType getStatusCode()
status
' field. The description of the 'status
'
field is:
"The status of a search job reflects the search job's current state. Values are:
0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable),
5 (Canceled), 6 (Access Denied)."
null
).STATUSCODE
public boolean isStatusCodeNull()
status
' field has been set to Null or not. The
description of the 'status
' field is:
"The status of a search job reflects the search job's current state. Values are:
0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable),
5 (Canceled), 6 (Access Denied)."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.STATUSCODE
public boolean isStatusCodeClear()
status
' field is clear or not. The description
of the 'status
' field is:
"The status of a search job reflects the search job's current state. Values are:
0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable),
5 (Canceled), 6 (Access Denied)."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.STATUSCODE
public int getPageSize()
pgsize
' field. The description of the 'pgsize
'
field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
null
).PAGESIZE
public boolean isPageSizeNull()
pgsize
' field has been set to Null or not. The
description of the 'pgsize
' field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setPageSizeNull()
,
PAGESIZE
public boolean isPageSizeClear()
pgsize
' field is clear or not. The description
of the 'pgsize
' field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearPageSize()
,
PAGESIZE
public void setPageSize(int pageSize)
pgsize
' field. The description of the 'pgsize
'
field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
pageSize
- Value to setPAGESIZE
public void clearPageSize()
pgsize
' field in the bean. The description
of the 'pgsize
' field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setPageSizeNull()
method to clear the server's value.
See the description of cleared
values.
PAGESIZE
public void setPageSizeNull()
pgsize
' field in the bean.
The description of the 'pgsize
' field is:
"The page size specifies the number of event objects that will be returned in a single
request for the results of the search job."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearPageSize()
method to avoid clearing the server's value.
See the description of Null
values.
PAGESIZE
public Date getLastAccessedTime()
last-accessed
' field. The description of the
'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
null
).LASTACCESSEDTIME
public boolean isLastAccessedTimeNull()
last-accessed
' field has been set to Null or
not. The description of the 'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setLastAccessedTimeNull()
,
LASTACCESSEDTIME
public boolean isLastAccessedTimeClear()
last-accessed
' field is clear or not.
The description of the 'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearLastAccessedTime()
,
LASTACCESSEDTIME
public void setLastAccessedTime(Date lastAccessedTime)
last-accessed
' field. The description of the
'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
lastAccessedTime
- Value to setLASTACCESSEDTIME
public void clearLastAccessedTime()
last-accessed
' field in the bean. The
description of the 'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setLastAccessedTimeNull()
method to clear the server's value.
See the description of cleared
values.
LASTACCESSEDTIME
public void setLastAccessedTimeNull()
last-accessed
' field in
the bean. The description of the 'last-accessed
' field is:
"The last accessed time is the last time the search job was accessed for the purposes
of getting search results."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearLastAccessedTime()
method to avoid clearing the server's value.
See the description of Null
values.
LASTACCESSEDTIME
public long getAvailableCount()
avail
' field. The description of the 'avail
'
field is:
"The available count number indicates the total number of events that are currently
available in the results that can be obtained from the search job."
null
).AVAILABLECOUNT
public boolean isAvailableCountNull()
avail
' field has been set to Null or not. The
description of the 'avail
' field is:
"The available count number indicates the total number of events that are currently
available in the results that can be obtained from the search job."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.AVAILABLECOUNT
public boolean isAvailableCountClear()
avail
' field is clear or not. The description
of the 'avail
' field is:
"The available count number indicates the total number of events that are currently
available in the results that can be obtained from the search job."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.AVAILABLECOUNT
public Date getJobStartTime()
job-start
' field. The description of the 'job-start
'
field is:
"The job start time is the time the search job started running."
null
).JOBSTARTTIME
public boolean isJobStartTimeNull()
job-start
' field has been set to Null or not.
The description of the 'job-start
' field is:
"The job start time is the time the search job started running."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setJobStartTimeNull()
,
JOBSTARTTIME
public boolean isJobStartTimeClear()
job-start
' field is clear or not. The
description of the 'job-start
' field is:
"The job start time is the time the search job started running."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearJobStartTime()
,
JOBSTARTTIME
public void setJobStartTime(Date jobStartTime)
job-start
' field. The description of the 'job-start
'
field is:
"The job start time is the time the search job started running."
jobStartTime
- Value to setJOBSTARTTIME
public void clearJobStartTime()
job-start
' field in the bean. The description
of the 'job-start
' field is:
"The job start time is the time the search job started running."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setJobStartTimeNull()
method to clear the server's value.
See the description of cleared
values.
JOBSTARTTIME
public void setJobStartTimeNull()
job-start
' field in the
bean. The description of the 'job-start
' field is:
"The job start time is the time the search job started running."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearJobStartTime()
method to avoid clearing the server's value.
See the description of Null
values.
JOBSTARTTIME
public EventSearchBean.TypeType getType()
type
' field. The description of the 'type
'
field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
null
).TYPE
public boolean isTypeNull()
type
' field has been set to Null or not. The
description of the 'type
' field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setTypeNull()
,
TYPE
public boolean isTypeClear()
type
' field is clear or not. The description
of the 'type
' field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearType()
,
TYPE
public void setType(EventSearchBean.TypeType type)
type
' field. The description of the 'type
'
field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
type
- Value to setTYPE
public void clearType()
type
' field in the bean. The description
of the 'type
' field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setTypeNull()
method to clear the server's value.
See the description of cleared
values.
TYPE
public void setTypeNull()
type
' field in the bean.
The description of the 'type
' field is:
"The type of a search job indicates the use for which the search job is started.
Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user.
"REPORT", used to obtain the results for use in a report. "DATASYNC", started to
obtain results that will be synchronized from the event store to a relational database.
"DIST", indicating a search started on behalf of a remote search console."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearType()
method to avoid clearing the server's value.
See the description of Null
values.
TYPE
public String getInitiatingIPAddress()
ip
' field. The description of the 'ip
'
field is:
"The IP address of the system from which the search job was initiated."
null
).INITIATINGIPADDRESS
public boolean isInitiatingIPAddressNull()
ip
' field has been set to Null or not. The description
of the 'ip
' field is:
"The IP address of the system from which the search job was initiated."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setInitiatingIPAddressNull()
,
INITIATINGIPADDRESS
public boolean isInitiatingIPAddressClear()
ip
' field is clear or not. The description
of the 'ip
' field is:
"The IP address of the system from which the search job was initiated."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearInitiatingIPAddress()
,
INITIATINGIPADDRESS
public void setInitiatingIPAddress(String initiatingIPAddress)
ip
' field. The description of the 'ip
'
field is:
"The IP address of the system from which the search job was initiated."
initiatingIPAddress
- Value to setINITIATINGIPADDRESS
public void clearInitiatingIPAddress()
ip
' field in the bean. The description
of the 'ip
' field is:
"The IP address of the system from which the search job was initiated."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setInitiatingIPAddressNull()
method to clear the server's value.
See the description of cleared
values.
INITIATINGIPADDRESS
public void setInitiatingIPAddressNull()
ip
' field in the bean.
The description of the 'ip
' field is:
"The IP address of the system from which the search job was initiated."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearInitiatingIPAddress()
method to avoid clearing the server's
value.
See the description of Null
values.
INITIATINGIPADDRESS
public String getAggregatingObjectLink()
aggregate-obj
' field. The description of the 'aggregate-obj
'
field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
null
).AGGREGATINGOBJECT
public boolean isAggregatingObjectLinkNull()
aggregate-obj
' URL field has been set to Null
or not. The description of the 'aggregate-obj
' field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setAggregatingObjectLinkNull()
,
AGGREGATINGOBJECT
public boolean isAggregatingObjectLinkClear()
aggregate-obj
' URL field is clear or
not. The description of the 'aggregate-obj
' field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearAggregatingObjectLink()
,
AGGREGATINGOBJECT
public void setAggregatingObjectLink(String aggregatingObject)
aggregate-obj
' field. The description of the
'aggregate-obj
' field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
aggregatingObject
- Value to setAGGREGATINGOBJECT
public void clearAggregatingObjectLink()
aggregate-obj
' field in the bean.
The description of the 'aggregate-obj
' field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setAggregatingObjectLinkNull()
method to clear the server's value.
See the description of cleared
values.
AGGREGATINGOBJECT
public void setAggregatingObjectLinkNull()
aggregate-obj
' field
in the bean. The description of the 'aggregate-obj
' field is:
"An "aggregating object" is a Sentinel object that has events associated with it.
Current objects are Incidents and Correlated Events. Specifying an aggregating object
restricts the results of the event search to only those events associated with the
aggregating object."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearAggregatingObjectLink()
method to avoid clearing the server's
value.
See the description of Null
values.
AGGREGATINGOBJECT
public String getResultsLink()
results
' field. The description of the 'results
'
field is:
"The results link is a URL that is used to obtain the first page of the results of
the search job."
null
).RESULTS
public boolean isResultsLinkNull()
results
' URL field has been set to Null or not.
The description of the 'results
' field is:
"The results link is a URL that is used to obtain the first page of the results of
the search job."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.RESULTS
public boolean isResultsLinkClear()
results
' URL field is clear or not. The
description of the 'results
' field is:
"The results link is a URL that is used to obtain the first page of the results of
the search job."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.RESULTS
public Date getDateRangeStart()
start
' field. The description of the 'start
'
field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
null
).DATERANGESTART
public boolean isDateRangeStartNull()
start
' field has been set to Null or not. The
description of the 'start
' field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setDateRangeStartNull()
,
DATERANGESTART
public boolean isDateRangeStartClear()
start
' field is clear or not. The description
of the 'start
' field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearDateRangeStart()
,
DATERANGESTART
public void setDateRangeStart(Date dateRangeStart)
start
' field. The description of the 'start
'
field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
dateRangeStart
- Value to setDATERANGESTART
public void clearDateRangeStart()
start
' field in the bean. The description
of the 'start
' field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setDateRangeStartNull()
method to clear the server's value.
See the description of cleared
values.
DATERANGESTART
public void setDateRangeStartNull()
start
' field in the bean.
The description of the 'start
' field is:
"The start of the search date range specifies the earliest date and time for which
events will be returned. The start of the range is inclusive."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearDateRangeStart()
method to avoid clearing the server's value.
See the description of Null
values.
DATERANGESTART
public long getMaximumResults()
max-results
' field. The description of the 'max-results
'
field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
null
).MAXIMUMRESULTS
public boolean isMaximumResultsNull()
max-results
' field has been set to Null or not.
The description of the 'max-results
' field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setMaximumResultsNull()
,
MAXIMUMRESULTS
public boolean isMaximumResultsClear()
max-results
' field is clear or not. The
description of the 'max-results
' field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearMaximumResults()
,
MAXIMUMRESULTS
public void setMaximumResults(long maximumResults)
max-results
' field. The description of the 'max-results
'
field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
maximumResults
- Value to setMAXIMUMRESULTS
public void clearMaximumResults()
max-results
' field in the bean. The
description of the 'max-results
' field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setMaximumResultsNull()
method to clear the server's value.
See the description of cleared
values.
MAXIMUMRESULTS
public void setMaximumResultsNull()
max-results
' field in
the bean. The description of the 'max-results
' field is:
"The maximum results number specifies the maximum event objects that the search job
will return. This may be less that the maximum event objects that match the search
parameters."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearMaximumResults()
method to avoid clearing the server's value.
See the description of Null
values.
MAXIMUMRESULTS
public Date getJobEndTime()
job-end
' field. The description of the 'job-end
'
field is:
"The job end time is the time the search job finished."
null
).JOBENDTIME
public boolean isJobEndTimeNull()
job-end
' field has been set to Null or not.
The description of the 'job-end
' field is:
"The job end time is the time the search job finished."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setJobEndTimeNull()
,
JOBENDTIME
public boolean isJobEndTimeClear()
job-end
' field is clear or not. The description
of the 'job-end
' field is:
"The job end time is the time the search job finished."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearJobEndTime()
,
JOBENDTIME
public void setJobEndTime(Date jobEndTime)
job-end
' field. The description of the 'job-end
'
field is:
"The job end time is the time the search job finished."
jobEndTime
- Value to setJOBENDTIME
public void clearJobEndTime()
job-end
' field in the bean. The description
of the 'job-end
' field is:
"The job end time is the time the search job finished."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setJobEndTimeNull()
method to clear the server's value.
See the description of cleared
values.
JOBENDTIME
public void setJobEndTimeNull()
job-end
' field in the
bean. The description of the 'job-end
' field is:
"The job end time is the time the search job finished."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearJobEndTime()
method to avoid clearing the server's value.
See the description of Null
values.
JOBENDTIME
public String getInitiatingUserName()
init-user
' field. The description of the 'init-user
'
field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
null
).INITIATINGUSERNAME
public boolean isInitiatingUserNameNull()
init-user
' field has been set to Null or not.
The description of the 'init-user
' field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setInitiatingUserNameNull()
,
INITIATINGUSERNAME
public boolean isInitiatingUserNameClear()
init-user
' field is clear or not. The
description of the 'init-user
' field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearInitiatingUserName()
,
INITIATINGUSERNAME
public void setInitiatingUserName(String initiatingUserName)
init-user
' field. The description of the 'init-user
'
field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
initiatingUserName
- Value to setINITIATINGUSERNAME
public void clearInitiatingUserName()
init-user
' field in the bean. The description
of the 'init-user
' field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setInitiatingUserNameNull()
method to clear the server's value.
See the description of cleared
values.
INITIATINGUSERNAME
public void setInitiatingUserNameNull()
init-user
' field in the
bean. The description of the 'init-user
' field is:
"The name of the user that initiated the search job. This may be different than the
Owner username if the search job is for a distributed search."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearInitiatingUserName()
method to avoid clearing the server's
value.
See the description of Null
values.
INITIATINGUSERNAME
public String getFilter()
filter
' field. The description of the 'filter
'
field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
null
).FILTER
public boolean isFilterNull()
filter
' field has been set to Null or not. The
description of the 'filter
' field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setFilterNull()
,
FILTER
public boolean isFilterClear()
filter
' field is clear or not. The description
of the 'filter
' field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearFilter()
,
FILTER
public void setFilter(String filter)
filter
' field. The description of the 'filter
'
field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
filter
- Value to setFILTER
public void clearFilter()
filter
' field in the bean. The description
of the 'filter
' field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setFilterNull()
method to clear the server's value.
See the description of cleared
values.
FILTER
public void setFilterNull()
filter
' field in the bean.
The description of the 'filter
' field is:
"The filter is the search query string that specifies the set of events that the
event search job will return."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearFilter()
method to avoid clearing the server's value.
See the description of Null
values.
FILTER
public Date getDateRangeEnd()
end
' field. The description of the 'end
'
field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
null
).DATERANGEEND
public boolean isDateRangeEndNull()
end
' field has been set to Null or not. The
description of the 'end
' field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setDateRangeEndNull()
,
DATERANGEEND
public boolean isDateRangeEndClear()
end
' field is clear or not. The description
of the 'end
' field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearDateRangeEnd()
,
DATERANGEEND
public void setDateRangeEnd(Date dateRangeEnd)
end
' field. The description of the 'end
'
field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
dateRangeEnd
- Value to setDATERANGEEND
public void clearDateRangeEnd()
end
' field in the bean. The description
of the 'end
' field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setDateRangeEndNull()
method to clear the server's value.
See the description of cleared
values.
DATERANGEEND
public void setDateRangeEndNull()
end
' field in the bean.
The description of the 'end
' field is:
"The end of the search date range specifies the latest date and time for which events
will be returned. The end of the range is exclusive."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearDateRangeEnd()
method to avoid clearing the server's value.
See the description of Null
values.
DATERANGEEND
public Collection<String> getFields()
fields
' field. The description of the 'fields
'
field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
null
).FIELDS
public boolean isFieldsNull()
fields
' field has been set to Null or not. The
description of the 'fields
' field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.setFieldsNull()
,
FIELDS
public boolean isFieldsClear()
fields
' field is clear or not. The description
of the 'fields
' field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.clearFields()
,
FIELDS
public void setFields(Collection<? extends String> fields)
fields
' field. The description of the 'fields
'
field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
fields
- Value to setFIELDS
public void clearFields()
fields
' field in the bean. The description
of the 'fields
' field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setFieldsNull()
method to clear the server's value.
See the description of cleared
values.
FIELDS
public void setFieldsNull()
fields
' field in the bean.
The description of the 'fields
' field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearFields()
method to avoid clearing the server's value.
See the description of Null
values.
FIELDS
public void addToFields(String value)
fields
'. The description of the
'fields
' field is:
"Fields is the set of event field names whose values are to be returned in the search
results. Limiting the result fields can descrease the amount of data that must be
transported. The special value "none" indicates that no field values are to be returned.
An empty set indicates that all field values are to be returned."
value
- Value to add to collection.FIELDS
public long getFoundCount()
found
' field. The description of the 'found
'
field is:
"The found count number indicates the total number of events found that match the
search job parameters."
null
).FOUNDCOUNT
public boolean isFoundCountNull()
found
' field has been set to Null or not. The
description of the 'found
' field is:
"The found count number indicates the total number of events found that match the
search job parameters."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.FOUNDCOUNT
public boolean isFoundCountClear()
found
' field is clear or not. The description
of the 'found
' field is:
"The found count number indicates the total number of events found that match the
search job parameters."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.FOUNDCOUNT
public String getOwnerLink()
owner
' field. The description of the 'owner
'
field is:
"The owner link is a URL that is used to obtain the user object of the user which
started the search job. The link will be empty for SYSTEM search jobs."
null
).OWNER
public boolean isOwnerLinkNull()
owner
' URL field has been set to Null or not.
The description of the 'owner
' field is:
"The owner link is a URL that is used to obtain the user object of the user which
started the search job. The link will be empty for SYSTEM search jobs."
See the description of Null
values.
true
if the field value has been marked as null, false
otherwise.OWNER
public boolean isOwnerLinkClear()
owner
' URL field is clear or not. The
description of the 'owner
' field is:
"The owner link is a URL that is used to obtain the user object of the user which
started the search job. The link will be empty for SYSTEM search jobs."
See the description of cleared
values.
true
if the field value has been cleared, false
otherwise.OWNER
public static BeanMetaData<? extends EventSearchBean> getBeanMetaData()
BeanTransporter
implementation''s constructor.
public EventSearchBean clone()
clone
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |