org.apache.gobblin.broker.iface

Interface ScopeInstance<S extends ScopeType<S>>

Type Parameters:

S - the ScopeType tree that this scope belongs to.

All Known Implementing Classes:

GobblinScopeInstance, JobScopeInstance, SimpleScope, TaskScopeInstance

public interface ScopeInstance<S extends ScopeType<S>>

A specific scope for a ScopeType. For example, each task in a process could be a different scope.

Note: ScopeInstances will be rendered using #toString(), and will be compared using #equals(Object). It is important to implement appropriate #equals(Object) and #hashCode() for correct functionality of SharedResourcesBroker. For example, if a scope for the same task is created in two different locations, they should still be equal under #equals(Object).

Method Summary

Modifier and Type	Method and Description
String	getScopeId()
S	getType()

Method Detail

getType

S getType()

Returns:

type of ScopeType.

getScopeId

String getScopeId()

Returns:

a String identifying this scope.