org.apache.gobblin.broker.iface

Interface ScopeType<S extends ScopeType<S>>

Type Parameters:

S - itself.

All Known Implementing Classes:

GobblinScopeTypes, SimpleScopeType

public interface ScopeType<S extends ScopeType<S>>

Represents a DAG of scope types. For example, the topology of a distributed application might have scopes as follows:

 GLOBAL -> INSTANCE --> JOB       --> TASK
                    \-> CONTAINER -/
 

Where global represents multiple separate instances or even other applications, the instance creates containers and process jobs, and each task of a job is run in a container. As seen in the graph, instance is a child of global, job and container are children of instance, and task is a child of both job and container.

Method Summary

Modifier and Type	Method and Description
ScopeInstance<S>	defaultScopeInstance()
boolean	isLocal()
String	name() The name of this ScopeType.
Collection<S>	parentScopes()
S	rootScope()

Method Detail

name

String name()

The name of this ScopeType.

isLocal

boolean isLocal()

Returns:

Whether this _scopeInstance is process-local or shared across different processes.

parentScopes

@Nullable
Collection<S> parentScopes()

Returns:

Collection of parent scopes in the DAG.

defaultScopeInstance

@Nullable
ScopeInstance<S> defaultScopeInstance()

Returns:

a default ScopeInstance for this ScopeType, or null if no such default exists.

rootScope

S rootScope()

Returns:

the root ScopeType in the DAG.