org.apache.gobblin.broker.gobblin_scopes

Enum GobblinScopeTypes

java.lang.Object

java.lang.Enum<GobblinScopeTypes>

org.apache.gobblin.broker.gobblin_scopes.GobblinScopeTypes

All Implemented Interfaces:

Serializable, Comparable<GobblinScopeTypes>, ScopeType<GobblinScopeTypes>

public enum GobblinScopeTypes
extends Enum<GobblinScopeTypes>
implements ScopeType<GobblinScopeTypes>

Scope topology for Gobblin ingestion applications.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINER
GLOBAL
INSTANCE
JOB
MULTI_TASK_ATTEMPT
TASK

Method Summary

Modifier and Type	Method and Description
ScopeInstance<GobblinScopeTypes>	defaultScopeInstance()
boolean	isLocal()
Collection<GobblinScopeTypes>	parentScopes()
GobblinScopeTypes	rootScope()
static GobblinScopeTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static GobblinScopeTypes[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.gobblin.broker.iface.ScopeType

name

Enum Constant Detail

GLOBAL

public static final GobblinScopeTypes GLOBAL

INSTANCE

public static final GobblinScopeTypes INSTANCE

JOB

public static final GobblinScopeTypes JOB

CONTAINER

public static final GobblinScopeTypes CONTAINER

MULTI_TASK_ATTEMPT

public static final GobblinScopeTypes MULTI_TASK_ATTEMPT

TASK

public static final GobblinScopeTypes TASK

Method Detail

values

public static GobblinScopeTypes[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GobblinScopeTypes c : GobblinScopeTypes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GobblinScopeTypes valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isLocal

public boolean isLocal()

Specified by:

isLocal in interface ScopeType<GobblinScopeTypes>

Returns:

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

parentScopes

public Collection<GobblinScopeTypes> parentScopes()

Specified by:

parentScopes in interface ScopeType<GobblinScopeTypes>

Returns:

Collection of parent scopes in the DAG.

defaultScopeInstance

@Nullable
public ScopeInstance<GobblinScopeTypes> defaultScopeInstance()

Specified by:

defaultScopeInstance in interface ScopeType<GobblinScopeTypes>

Returns:

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

rootScope

public GobblinScopeTypes rootScope()

Specified by:

rootScope in interface ScopeType<GobblinScopeTypes>

Returns:

the root ScopeType in the DAG.