@InterfaceAudience.Private @InterfaceStability.Unstable public class TimelineReaderWebServices extends Object
Constructor and Description |
---|
TimelineReaderWebServices() |
Modifier and Type | Method and Description |
---|---|
org.apache.hadoop.yarn.api.records.timeline.TimelineAbout |
about(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Return the description of the timeline reader web services.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getApp(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String uId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd)
Return a single app for given UID which is a delimited string containing
clusterid, userid, flow name, flowrun id and app id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getApp(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String flowName,
String flowRunId,
String userId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd)
Return a single app for given app id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getApp(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String flowName,
String flowRunId,
String userId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd)
Return a single app for given cluster id and app id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getAppAttempt(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String appAttemptId,
String userId,
String flowName,
String flowRunId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix)
Return a single application-attempt entity for the given attempt Id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getAppAttempt(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String appAttemptId,
String userId,
String flowName,
String flowRunId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix)
Return a single application attempt entity of the given entity Id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getAppAttempts(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a set of application-attempt entities for a given applicationId.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getAppAttempts(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a set of application-attempt entities for a given applicationId.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getContainer(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String containerId,
String userId,
String flowName,
String flowRunId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix)
Return a single container entity for the given container Id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getContainer(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String containerId,
String userId,
String flowName,
String flowRunId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix)
Return a single container entity for the given container Id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getContainers(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String appattemptId,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a set of container entities belonging to given application attempt
id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getContainers(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String appattemptId,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a set of container entities belonging to given application attempt
id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String uId,
String entityType,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a single entity for a given entity type and UID which is a delimited
string containing clusterid, userid, flow name, flowrun id and app id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String entityType,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a set of entities that match the given parameters.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String entityType,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a set of entities that match the given parameters.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getEntity(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String uId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd)
Return a single entity for given UID which is a delimited string containing
clusterid, userid, flow name, flowrun id, app id, entity type and entityid.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getEntity(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String entityType,
String entityId,
String userId,
String flowName,
String flowRunId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix)
Return a single entity of the given entity type and Id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getEntity(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String entityType,
String entityId,
String userId,
String flowName,
String flowRunId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix)
Return a single entity of the given entity type and Id.
|
Set<String> |
getEntityTypes(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String appId,
String flowName,
String flowRunId,
String userId)
Returns a set of available entity types for a given app id.
|
Set<String> |
getEntityTypes(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String appId,
String flowName,
String flowRunId,
String userId)
Returns a set of available entity types for a given app id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowApps(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String userId,
String flowName,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a list of apps for given user and flow name.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowApps(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String userId,
String flowName,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a list of apps for a given user, cluster id and flow name.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getFlowRun(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String uId,
String metricsToRetrieve)
Return a single flow run for given UID which is a delimited string
containing clusterid, userid, flow name and flowrun id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getFlowRun(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String userId,
String flowName,
String flowRunId,
String metricsToRetrieve)
Return a single flow run for the given user, flow name and run id.
|
org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity |
getFlowRun(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String userId,
String flowName,
String flowRunId,
String metricsToRetrieve)
Return a single flow run for the given user, cluster, flow name and run id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowRunApps(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String uId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a list of apps for given UID which is a delimited string containing
clusterid, userid, flow name and flowrun id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowRunApps(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a list of apps for given user, flow name and flow run id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowRunApps(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String userId,
String flowName,
String flowRunId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId)
Return a list of apps for a given user, cluster id, flow name and flow run
id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowRuns(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String uId,
String limit,
String createdTimeStart,
String createdTimeEnd,
String metricsToRetrieve,
String fields,
String fromId)
Return a list of flow runs for given UID which is a delimited string
containing clusterid, userid and flow name.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowRuns(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String userId,
String flowName,
String limit,
String createdTimeStart,
String createdTimeEnd,
String metricsToRetrieve,
String fields,
String fromId)
Return a set of flows runs for the given user and flow name.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlowRuns(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String userId,
String flowName,
String limit,
String createdTimeStart,
String createdTimeEnd,
String metricsToRetrieve,
String fields,
String fromId)
Return a set of flows runs for the given cluster, user and flow name.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlows(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String limit,
String dateRange,
String fromId)
Return a list of active flows.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getFlows(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String limit,
String dateRange,
String fromId)
Return a list of active flows for a given cluster id.
|
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getSubAppEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String userId,
String entityType,
String entityId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix) |
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getSubAppEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String userId,
String entityType,
String entityId,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String entityIdPrefix) |
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getSubAppEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String userId,
String entityType,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId) |
Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> |
getSubAppEntities(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
String clusterId,
String userId,
String entityType,
String limit,
String createdTimeStart,
String createdTimeEnd,
String relatesTo,
String isRelatedTo,
String infofilters,
String conffilters,
String metricfilters,
String eventfilters,
String confsToRetrieve,
String metricsToRetrieve,
String fields,
String metricsLimit,
String metricsTimeStart,
String metricsTimeEnd,
String fromId) |
javax.ws.rs.core.Response |
health(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Health check REST end point.
|
public org.apache.hadoop.yarn.api.records.timeline.TimelineAbout about(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res)
req
- Servlet request.res
- Servlet response.public javax.ws.rs.core.Response health(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res)
req
- Servlet request.res
- Servlet response.Response
object with HTTP status 200 OK if the service
is running.
Otherwise, a Response
object with HTTP status 500 is
returned.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String uId, String entityType, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.uId
- a delimited string containing clusterid, userid, flow name,
flowrun id and app id which are extracted from UID and then used to
query backend(Mandatory path param).entityType
- Type of entities(Mandatory path param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format [entitytype]:[entityid1]:[entityid2]...
(Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as
metricfilters=metricid1, metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id and created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the entities
would not contain metric values before this timestamp(Optional query
param).metricsTimeEnd
- If specified, returned metrics for the entities would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of entities from the
given fromId. The set of entities retrieved is inclusive of specified
fromId. fromId should be taken from the value associated with FROM_ID
info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String entityType, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.appId
- Application id to which the entities to be queried belong to(
Mandatory path param).entityType
- Type of entities(Mandatory path param).userId
- User id which should match for the entities(Optional query
param)flowName
- Flow name which should match for the entities(Optional
query param).flowRunId
- Run id which should match for the entities(Optional query
param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format [entitytype]:[entityid1]:[entityid2]...
(Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as
metricfilters=metricid1, metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the entities
would not contain metric values before this timestamp(Optional query
param).metricsTimeEnd
- If specified, returned metrics for the entities would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of entities from the
given fromId. The set of entities retrieved is inclusive of specified
fromId. fromId should be taken from the value associated with FROM_ID
info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String entityType, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the entities to be queried belong to(
Mandatory path param).appId
- Application id to which the entities to be queried belong to(
Mandatory path param).entityType
- Type of entities(Mandatory path param).userId
- User id which should match for the entities(Optional query
param)flowName
- Flow name which should match for the entities(Optional
query param).flowRunId
- Run id which should match for the entities(Optional query
param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format [entitytype]:[entityid1]:[entityid2]...
(Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as
metricfilters=metricid1, metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the entities
would not contain metric values before this timestamp(Optional query
param).metricsTimeEnd
- If specified, returned metrics for the entities would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of entities from the
given fromId. The set of entities retrieved is inclusive of specified
fromId. fromId should be taken from the value associated with FROM_ID
info key in entity response which was sent earlier.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getEntity(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String uId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd)
req
- Servlet request.res
- Servlet response.uId
- a delimited string containing clusterid, userid, flow name,
flowrun id, app id, entity type and entity id which are extracted from
UID and then used to query backend(Mandatory path param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the entity would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the entity would
not contain metric values after this timestamp(Optional query param).public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getEntity(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String entityType, String entityId, String userId, String flowName, String flowRunId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
req
- Servlet request.res
- Servlet response.appId
- Application id to which the entity to be queried belongs to(
Mandatory path param).entityType
- Type of entity(Mandatory path param).entityId
- Id of the entity to be fetched(Mandatory path param).userId
- User id which should match for the entity(Optional query
param).flowName
- Flow name which should match for the entity(Optional query
param).flowRunId
- Run id which should match for the entity(Optional query
param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the entity would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the entity would
not contain metric values after this timestamp(Optional query param).entityIdPrefix
- Defines the id prefix for the entity to be fetched.
If specified, then entity retrieval will be faster.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getEntity(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String entityType, String entityId, String userId, String flowName, String flowRunId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the entity to be queried belongs to(
Mandatory path param).appId
- Application id to which the entity to be queried belongs to(
Mandatory path param).entityType
- Type of entity(Mandatory path param).entityId
- Id of the entity to be fetched(Mandatory path param).userId
- User id which should match for the entity(Optional query
param).flowName
- Flow name which should match for the entity(Optional query
param).flowRunId
- Run id which should match for the entity(Optional query
param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id and created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the entity would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the entity would
not contain metric values after this timestamp(Optional query param).entityIdPrefix
- Defines the id prefix for the entity to be fetched.
If specified, then entity retrieval will be faster.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getFlowRun(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String uId, String metricsToRetrieve)
req
- Servlet request.res
- Servlet response.uId
- a delimited string containing clusterid, userid, flow name and
flowrun id which are extracted from UID and then used to query backend
(Mandatory path param).metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getFlowRun(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String userId, String flowName, String flowRunId, String metricsToRetrieve)
req
- Servlet request.res
- Servlet response.userId
- User id representing the user who ran the flow run(Mandatory
path param).flowName
- Flow name to which the flow run to be queried belongs to(
Mandatory path param).flowRunId
- Id of the flow run to be queried(Mandatory path param).metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getFlowRun(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String userId, String flowName, String flowRunId, String metricsToRetrieve)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the flow run to be queried belong to(
Mandatory path param).userId
- User id representing the user who ran the flow run(Mandatory
path param).flowName
- Flow name to which the flow run to be queried belongs to(
Mandatory path param).flowRunId
- Id of the flow run to be queried(Mandatory path param).metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowRuns(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String uId, String limit, String createdTimeStart, String createdTimeEnd, String metricsToRetrieve, String fields, String fromId)
req
- Servlet request.res
- Servlet response.uId
- a delimited string containing clusterid, userid, and flow name
which are extracted from UID and then used to query backend(Mandatory
path param).limit
- If specified, defines the number of flow runs to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched flow runs should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched flow runs should not be created
after this timestamp(Optional query param).metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields to retrieve, see TimelineReader.Field
. All
fields will be retrieved if fields=ALL. Amongst all the fields, only
METRICS makes sense for flow runs hence only ALL or METRICS are
supported as fields for fetching flow runs. Other fields will lead to
HTTP 400 (Bad Request) response. (Optional query param).fromId
- If specified, retrieve the next set of flow run entities
from the given fromId. The set of entities retrieved is inclusive of
specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowRuns(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String userId, String flowName, String limit, String createdTimeStart, String createdTimeEnd, String metricsToRetrieve, String fields, String fromId)
req
- Servlet request.res
- Servlet response.userId
- User id representing the user who ran the flow runs(
Mandatory path param)flowName
- Flow name to which the flow runs to be queried belongs to(
Mandatory path param).limit
- If specified, defines the number of flow runs to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched flow runs should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched flow runs should not be created
after this timestamp(Optional query param).metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields to retrieve, see TimelineReader.Field
. All
fields will be retrieved if fields=ALL. Amongst all the fields, only
METRICS makes sense for flow runs hence only ALL or METRICS are
supported as fields for fetching flow runs. Other fields will lead to
HTTP 400 (Bad Request) response. (Optional query param).fromId
- If specified, retrieve the next set of flow run entities
from the given fromId. The set of entities retrieved is inclusive of
specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowRuns(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String userId, String flowName, String limit, String createdTimeStart, String createdTimeEnd, String metricsToRetrieve, String fields, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the flow runs to be queried belong to(
Mandatory path param).userId
- User id representing the user who ran the flow runs(
Mandatory path param)flowName
- Flow name to which the flow runs to be queried belongs to(
Mandatory path param).limit
- If specified, defines the number of flow runs to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched flow runs should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched flow runs should not be created
after this timestamp(Optional query param).metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields to retrieve, see TimelineReader.Field
. All
fields will be retrieved if fields=ALL. Amongst all the fields, only
METRICS makes sense for flow runs hence only ALL or METRICS are
supported as fields for fetching flow runs. Other fields will lead to
HTTP 400 (Bad Request) response. (Optional query param).fromId
- If specified, retrieve the next set of flow run entities
from the given fromId. The set of entities retrieved is inclusive of
specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlows(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String limit, String dateRange, String fromId)
req
- Servlet request.res
- Servlet response.limit
- If specified, defines the number of flows to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).dateRange
- If specified is given as "[startdate]-[enddate]"(i.e.
start and end date separated by "-") or single date. Dates are
interpreted in yyyyMMdd format and are assumed to be in GMT(Optional
query param).
If a single date is specified, all flows active on that date are
returned. If both startdate and enddate is given, all flows active
between start and end date will be returned. If only startdate is
given, flows active on and after startdate are returned. If only
enddate is given, flows active on and before enddate are returned.
For example :
"daterange=20150711" returns flows active on 20150711.
"daterange=20150711-20150714" returns flows active between these
2 dates.
"daterange=20150711-" returns flows active on and after 20150711.
"daterange=-20150711" returns flows active on and before 20150711.fromId
- If specified, retrieve the next set of flows from the given
fromId. The set of flows retrieved is inclusive of specified fromId.
fromId should be taken from the value associated with FROM_ID info key
in flow entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlows(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String limit, String dateRange, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the flows to be queried belong to(
Mandatory path param).limit
- If specified, defines the number of flows to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).dateRange
- If specified is given as "[startdate]-[enddate]"(i.e.
start and end date separated by "-") or single date. Dates are
interpreted in yyyyMMdd format and are assumed to be in GMT(Optional
query param).
If a single date is specified, all flows active on that date are
returned. If both startdate and enddate is given, all flows active
between start and end date will be returned. If only startdate is
given, flows active on and after startdate are returned. If only
enddate is given, flows active on and before enddate are returned.
For example :
"daterange=20150711" returns flows active on 20150711.
"daterange=20150711-20150714" returns flows active between these
2 dates.
"daterange=20150711-" returns flows active on and after 20150711.
"daterange=-20150711" returns flows active on and before 20150711.fromId
- If specified, retrieve the next set of flows from the given
fromId. The set of flows retrieved is inclusive of specified fromId.
fromId should be taken from the value associated with FROM_ID info key
in flow entity response which was sent earlier.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getApp(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String uId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd)
req
- Servlet request.res
- Servlet response.uId
- a delimited string containing clusterid, userid, flow name, flow
run id and app id which are extracted from UID and then used to query
backend(Mandatory path param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the apps would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the apps would
not contain metric values after this timestamp(Optional query param).public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getApp(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String flowName, String flowRunId, String userId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd)
req
- Servlet request.res
- Servlet response.appId
- Application id to be queried(Mandatory path param).flowName
- Flow name which should match for the app(Optional query
param).flowRunId
- Run id which should match for the app(Optional query
param).userId
- User id which should match for the app(Optional query param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the app would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the app would
not contain metric values after this timestamp(Optional query param).public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getApp(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String flowName, String flowRunId, String userId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the app to be queried belong to(
Mandatory path param).appId
- Application id to be queried(Mandatory path param).flowName
- Flow name which should match for the app(Optional query
param).flowRunId
- Run id which should match for the app(Optional query
param).userId
- User id which should match for the app(Optional query param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the app would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the app would
not contain metric values after this timestamp(Optional query param).public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowRunApps(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String uId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.uId
- a delimited string containing clusterid, userid, flow name and
flowrun id which are extracted from UID and then used to query backend.
(Mandatory path param).limit
- If specified, defines the number of apps to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched apps should not be created
before this timestamp(Optional query param).createdTimeEnd
- If specified, matched apps should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched apps should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched apps should be related to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).infofilters
- If specified, matched apps should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched apps should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched apps should contain the given
metrics. This is represented as metricfilters=metricid1, metricid2...
(Optional query param).eventfilters
- If specified, matched apps should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the apps would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the apps would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of applications
from the given fromId. The set of applications retrieved is inclusive
of specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowRunApps(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.userId
- User id which should match for the apps(Mandatory path param)flowName
- Flow name which should match for the apps(Mandatory path
param).flowRunId
- Run id which should match for the apps(Mandatory path
param).limit
- If specified, defines the number of apps to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched apps should not be created
before this timestamp(Optional query param).createdTimeEnd
- If specified, matched apps should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched apps should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched apps should be related to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).infofilters
- If specified, matched apps should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched apps should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched apps should contain the given
metrics. This is represented as metricfilters=metricid1, metricid2...
(Optional query param).eventfilters
- If specified, matched apps should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the apps would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the apps would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of applications
from the given fromId. The set of applications retrieved is inclusive
of specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowRunApps(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the apps to be queried belong to
(Mandatory path param).userId
- User id which should match for the apps(Mandatory path param)flowName
- Flow name which should match for the apps(Mandatory path
param).flowRunId
- Run id which should match for the apps(Mandatory path
param).limit
- If specified, defines the number of apps to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched apps should not be created
before this timestamp(Optional query param).createdTimeEnd
- If specified, matched apps should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched apps should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched apps should be related to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).infofilters
- If specified, matched apps should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched apps should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched apps should contain the given
metrics. This is represented as metricfilters=metricid1, metricid2...
(Optional query param).eventfilters
- If specified, matched apps should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the apps would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the apps would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of applications
from the given fromId. The set of applications retrieved is inclusive
of specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowApps(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String userId, String flowName, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.userId
- User id which should match for the apps(Mandatory path param)flowName
- Flow name which should match for the apps(Mandatory path
param).limit
- If specified, defines the number of apps to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched apps should not be created
before this timestamp(Optional query param).createdTimeEnd
- If specified, matched apps should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched apps should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched apps should be related to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).infofilters
- If specified, matched apps should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched apps should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched apps should contain the given
metrics. This is represented as metricfilters=metricid1, metricid2...
(Optional query param).eventfilters
- If specified, matched apps should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the apps would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the apps would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of applications
from the given fromId. The set of applications retrieved is inclusive
of specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getFlowApps(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String userId, String flowName, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the apps to be queried belong to
(Mandatory path param).userId
- User id which should match for the apps(Mandatory path param)flowName
- Flow name which should match for the apps(Mandatory path
param).limit
- If specified, defines the number of apps to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If it
is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched apps should not be created
before this timestamp(Optional query param).createdTimeEnd
- If specified, matched apps should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched apps should relate to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).isRelatedTo
- If specified, matched apps should be related to given
entities associated with a entity type. relatesto is a comma separated
list in the format [entitytype]:[entityid1]:[entityid2]... (Optional
query param).infofilters
- If specified, matched apps should have exact matches
to the given info represented as key-value pairs. This is represented
as infofilters=info1:value1,info2:value2... (Optional query param).conffilters
- If specified, matched apps should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional query
param).metricfilters
- If specified, matched apps should contain the given
metrics. This is represented as metricfilters=metricid1, metricid2...
(Optional query param).eventfilters
- If specified, matched apps should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be retrieved
irrespective of whether configs are specified in fields to retrieve or
not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to retrieve or
not.fields
- Specifies which fields of the app entity object to retrieve,
see TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type(equivalent to YARN_APPLICATION),
app id and app created time is returned(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or metricsToRetrieve is
specified. Ignored otherwise. The maximum possible value for
metricsLimit can be Integer.MAX_VALUE
. If it is not specified
or has a value less than 1, and metrics have to be retrieved, then
metricsLimit will be considered as 1 i.e. latest single value of
metric(s) will be returned. (Optional query param).metricsTimeStart
- If specified, returned metrics for the apps would
not contain metric values before this timestamp(Optional query param).metricsTimeEnd
- If specified, returned metrics for the apps would
not contain metric values after this timestamp(Optional query param).fromId
- If specified, retrieve the next set of applications
from the given fromId. The set of applications retrieved is inclusive
of specified fromId. fromId should be taken from the value associated
with FROM_ID info key in entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getAppAttempts(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.appId
- Application id to which the entities to be queried belong to(
Mandatory path param).userId
- User id which should match for the entities(Optional query
param)flowName
- Flow name which should match for the entities(Optional
query param).flowRunId
- Run id which should match for the entities(Optional query
param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If
it is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is
represented as infofilters=info1:value1,info2:value2... (Optional
query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional
query param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as metricfilters=metricid1,
metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the app attempts
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the app attempts
would not contain metric values after this timestamp(Optional
query param).fromId
- If specified, retrieve the next set of application-attempt
entities from the given fromId. The set of application-attempt
entities retrieved is inclusive of specified fromId. fromId should
be taken from the value associated with FROM_ID info key in
entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getAppAttempts(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the entities to be queried belong to(
Mandatory path param).appId
- Application id to which the entities to be queried belong to(
Mandatory path param).userId
- User id which should match for the entities(Optional query
param)flowName
- Flow name which should match for the entities(Optional
query param).flowRunId
- Run id which should match for the entities(Optional query
param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If
it is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is
represented as infofilters=info1:value1,info2:value2... (Optional
query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional
query param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as metricfilters=metricid1,
metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the app attempts
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the app attempts
would not contain metric values after this timestamp(Optional
query param).fromId
- If specified, retrieve the next set of application-attempt
entities from the given fromId. The set of application-attempt
entities retrieved is inclusive of specified fromId. fromId should
be taken from the value associated with FROM_ID info key in
entity response which was sent earlier.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getAppAttempt(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String appAttemptId, String userId, String flowName, String flowRunId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
req
- Servlet request.res
- Servlet response.appId
- Application id to which the entity to be queried belongs to(
Mandatory path param).appAttemptId
- Application Attempt Id to which the containers belong
to( Mandatory path param).userId
- User id which should match for the entity(Optional query
param).flowName
- Flow name which should match for the entity(Optional query
param).flowRunId
- Run id which should match for the entity(Optional query
param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the app attempt
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the app attempt
would not contain metric values after this timestamp(Optional
query param).entityIdPrefix
- Defines the id prefix for the entity to be fetched.
If specified, then entity retrieval will be faster.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getAppAttempt(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String appAttemptId, String userId, String flowName, String flowRunId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the entity to be queried belongs to(
Mandatory path param).appId
- Application id to which the entity to be queried belongs to(
Mandatory path param).appAttemptId
- Application Attempt Id to which the containers belong
to( Mandatory path param).userId
- User id which should match for the entity(Optional query
param).flowName
- Flow name which should match for the entity(Optional query
param).flowRunId
- Run id which should match for the entity(Optional query
param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id and created time is
returned (Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the app attempt
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the app attempt
would not contain metric values after this timestamp(Optional
query param).entityIdPrefix
- Defines the id prefix for the entity to be fetched.
If specified, then entity retrieval will be faster.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getContainers(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String appattemptId, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.appId
- Application id to which the entities to be queried belong to(
Mandatory path param).appattemptId
- Application Attempt Id to which the containers belong
to( Mandatory path param).userId
- User id which should match for the entities(Optional query
param)flowName
- Flow name which should match for the entities(Optional
query param).flowRunId
- Run id which should match for the entities(Optional query
param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If
it is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is
represented as infofilters=info1:value1,info2:value2... (Optional
query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional
query param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as metricfilters=metricid1,
metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the containers
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the containers
would not contain metric values after this timestamp(Optional
query param).fromId
- If specified, retrieve the next set of container
entities from the given fromId. The set of container
entities retrieved is inclusive of specified fromId. fromId should
be taken from the value associated with FROM_ID info key in
entity response which was sent earlier.public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getContainers(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String appattemptId, String userId, String flowName, String flowRunId, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the entities to be queried belong to(
Mandatory path param).appId
- Application id to which the entities to be queried belong to(
Mandatory path param).appattemptId
- Application Attempt Id to which the containers belong
to( Mandatory path param).userId
- User id which should match for the entities(Optional query
param)flowName
- Flow name which should match for the entities(Optional
query param).flowRunId
- Run id which should match for the entities(Optional query
param).limit
- If specified, defines the number of entities to return. The
maximum possible value for limit can be Long.MAX_VALUE
. If
it is not specified or has a value less than 0, then limit will be
considered as 100. (Optional query param).createdTimeStart
- If specified, matched entities should not be
created before this timestamp(Optional query param).createdTimeEnd
- If specified, matched entities should not be created
after this timestamp(Optional query param).relatesTo
- If specified, matched entities should relate to given
entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).isRelatedTo
- If specified, matched entities should be related to
given entities associated with a entity type. relatesto is a comma
separated list in the format
[entitytype]:[entityid1]:[entityid2]... (Optional query param).infofilters
- If specified, matched entities should have exact matches
to the given info represented as key-value pairs. This is
represented as infofilters=info1:value1,info2:value2... (Optional
query param).conffilters
- If specified, matched entities should have exact matches
to the given configs represented as key-value pairs. This is
represented as conffilters=conf1:value1,conf2:value2... (Optional
query param).metricfilters
- If specified, matched entities should contain the
given metrics. This is represented as metricfilters=metricid1,
metricid2... (Optional query param).eventfilters
- If specified, matched entities should contain the given
events. This is represented as eventfilters=eventid1, eventid2...confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the containers
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the containers
would not contain metric values after this timestamp(Optional
query param).fromId
- If specified, retrieve the next set of container
entities from the given fromId. The set of container
entities retrieved is inclusive of specified fromId. fromId should
be taken from the value associated with FROM_ID info key in
entity response which was sent earlier.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getContainer(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String containerId, String userId, String flowName, String flowRunId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
req
- Servlet request.res
- Servlet response.appId
- Application id to which the entity to be queried belongs to(
Mandatory path param).containerId
- Container Id to which the entity to be queried belongs
to( Mandatory path param).userId
- User id which should match for the entity(Optional query
param).flowName
- Flow name which should match for the entity(Optional query
param).flowRunId
- Run id which should match for the entity(Optional query
param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id, created time is returned
(Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the container
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the container
would not contain metric values after this timestamp(Optional
query param).entityIdPrefix
- Defines the id prefix for the entity to be fetched.
If specified, then entity retrieval will be faster.public org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getContainer(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String containerId, String userId, String flowName, String flowRunId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the entity to be queried belongs to(
Mandatory path param).appId
- Application id to which the entity to be queried belongs to(
Mandatory path param).containerId
- Container Id to which the entity to be queried belongs
to( Mandatory path param).userId
- User id which should match for the entity(Optional query
param).flowName
- Flow name which should match for the entity(Optional query
param).flowRunId
- Run id which should match for the entity(Optional query
param).confsToRetrieve
- If specified, defines which configurations to
retrieve and send back in response. These configs will be
retrieved irrespective of whether configs are specified in fields
to retrieve or not.metricsToRetrieve
- If specified, defines which metrics to retrieve
and send back in response. These metrics will be retrieved
irrespective of whether metrics are specified in fields to
retrieve or not.fields
- Specifies which fields of the entity object to retrieve, see
TimelineReader.Field
. All fields will be retrieved if fields=ALL. If not
specified, 3 fields i.e. entity type, id and created time is
returned (Optional query param).metricsLimit
- If specified, defines the number of metrics to return.
Considered only if fields contains METRICS/ALL or
metricsToRetrieve is specified. Ignored otherwise. The maximum
possible value for metricsLimit can be Integer.MAX_VALUE
.
If it is not specified or has a value less than 1, and metrics
have to be retrieved, then metricsLimit will be considered as 1
i.e. latest single value of metric(s) will be returned. (Optional
query param).metricsTimeStart
- If specified, returned metrics for the container
would not contain metric values before this timestamp(Optional
query param).metricsTimeEnd
- If specified, returned metrics for the container
would not contain metric values after this timestamp(Optional
query param).entityIdPrefix
- Defines the id prefix for the entity to be fetched.
If specified, then entity retrieval will be faster.public Set<String> getEntityTypes(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String appId, String flowName, String flowRunId, String userId)
req
- Servlet request.res
- Servlet response.appId
- Application id to be queried(Mandatory path param).flowName
- Flow name which should match for the app(Optional query
param).flowRunId
- Run id which should match for the app(Optional query
param).userId
- User id which should match for the app(Optional query param).public Set<String> getEntityTypes(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String appId, String flowName, String flowRunId, String userId)
req
- Servlet request.res
- Servlet response.clusterId
- Cluster id to which the app to be queried belong to(
Mandatory path param).appId
- Application id to be queried(Mandatory path param).flowName
- Flow name which should match for the app(Optional query
param).flowRunId
- Run id which should match for the app(Optional query
param).userId
- User id which should match for the app(Optional query param).public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getSubAppEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String userId, String entityType, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getSubAppEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String userId, String entityType, String limit, String createdTimeStart, String createdTimeEnd, String relatesTo, String isRelatedTo, String infofilters, String conffilters, String metricfilters, String eventfilters, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String fromId)
public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getSubAppEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String userId, String entityType, String entityId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
public Set<org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity> getSubAppEntities(@Context javax.servlet.http.HttpServletRequest req, @Context javax.servlet.http.HttpServletResponse res, String clusterId, String userId, String entityType, String entityId, String confsToRetrieve, String metricsToRetrieve, String fields, String metricsLimit, String metricsTimeStart, String metricsTimeEnd, String entityIdPrefix)
Copyright © 2008–2021 Apache Software Foundation. All rights reserved.