Package org.apache.flink.runtime.metrics.dump

Class QueryScopeInfo

java.lang.Object

org.apache.flink.runtime.metrics.dump.QueryScopeInfo

Direct Known Subclasses:

QueryScopeInfo.JobManagerOperatorQueryScopeInfo, QueryScopeInfo.JobManagerQueryScopeInfo, QueryScopeInfo.JobQueryScopeInfo, QueryScopeInfo.OperatorQueryScopeInfo, QueryScopeInfo.TaskManagerQueryScopeInfo, QueryScopeInfo.TaskQueryScopeInfo

public abstract class QueryScopeInfo
extends Object

Container for scope related information as required by the MetricQueryService.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryScopeInfo.JobManagerOperatorQueryScopeInfo	Container for the job manager operator scope.
static class	QueryScopeInfo.JobManagerQueryScopeInfo	Container for the job manager scope.
static class	QueryScopeInfo.JobQueryScopeInfo	Container for the job scope.
static class	QueryScopeInfo.OperatorQueryScopeInfo	Container for the operator scope.
static class	QueryScopeInfo.TaskManagerQueryScopeInfo	Container for the task manager scope.
static class	QueryScopeInfo.TaskQueryScopeInfo	Container for the task scope.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	INFO_CATEGORY_JM	Categories to be returned by getCategory() to avoid instanceof checks.
static final byte	INFO_CATEGORY_JM_OPERATOR
static final byte	INFO_CATEGORY_JOB
static final byte	INFO_CATEGORY_OPERATOR
static final byte	INFO_CATEGORY_TASK
static final byte	INFO_CATEGORY_TM
final String	scope	The remaining scope not covered by specific fields.

Method Summary

Modifier and Type	Method	Description
protected String	concatScopes(String additionalScope)
abstract QueryScopeInfo	copy(String userScope)	Create a copy of this QueryScopeInfo and append the given scope.
abstract byte	getCategory()	Returns the category for this QueryScopeInfo.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

INFO_CATEGORY_JM

public static final byte INFO_CATEGORY_JM

Categories to be returned by getCategory() to avoid instanceof checks.

See Also:

• Constant Field Values

INFO_CATEGORY_TM

public static final byte INFO_CATEGORY_TM

See Also:

• Constant Field Values

INFO_CATEGORY_JOB

public static final byte INFO_CATEGORY_JOB

See Also:

• Constant Field Values

INFO_CATEGORY_TASK

public static final byte INFO_CATEGORY_TASK

See Also:

• Constant Field Values

INFO_CATEGORY_OPERATOR

public static final byte INFO_CATEGORY_OPERATOR

See Also:

• Constant Field Values

INFO_CATEGORY_JM_OPERATOR

public static final byte INFO_CATEGORY_JM_OPERATOR

See Also:

• Constant Field Values

scope

public final String scope

The remaining scope not covered by specific fields.

Method Details

copy

public abstract QueryScopeInfo copy(String userScope)

Create a copy of this QueryScopeInfo and append the given scope.

Parameters:

userScope - scope to append

Returns:

modified copy of this QueryScopeInfo

getCategory

public abstract byte getCategory()

Returns the category for this QueryScopeInfo.

Returns:

category

toString

public String toString()

Overrides:

toString in class Object

concatScopes

protected String concatScopes(String additionalScope)