io.cdap.cdap.api.lineage.field

Class EndPoint

java.lang.Object

io.cdap.cdap.api.lineage.field.EndPoint

public class EndPoint
extends Object

An EndPoint in an operation represents the source or destination of the data, along with the namespace in which they exists. When namespace is not provided, the namespace for an EndPoint is considered to be same as the namespace in which program runs.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName()
String	getNamespace()
Map<String,String>	getProperties()
int	hashCode()
static EndPoint	of(String name) Return the EndPoint as defined by the provided name.
static EndPoint	of(String namespace, String name) Return the EndPoint as defined by the provided namespace and name.
static EndPoint	of(String namespace, String name, Map<String,String> properties) Return the EndPoint as defined by the provided namespace, name and properties.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getNamespace

@Nullable
public String getNamespace()

Returns:

the namespace name if it is explicitly provided while creating this EndPoint, otherwise null is returned. Also, in the case where in a pipeline a field is dropped, the dropped EndPointField is mapped to a blank EndPointField with namespace set to null.

getName

@Nullable
public String getName()

Returns:

the name of the EndPoint Name can be null in the case where in a pipeline a field is dropped, and the dropped EndPointField is mapped to a blank EndPointField with name set to null.

getProperties

public Map<String,String> getProperties()

Returns:

the properties of the EndPoint. e.g. location

of

public static EndPoint of(String name)

Return the EndPoint as defined by the provided name.

Parameters:

name - the name of the EndPoint

Returns:

the EndPoint

of

public static EndPoint of(String namespace,
                          String name)

Return the EndPoint as defined by the provided namespace and name.

Parameters:

namespace - the name of the namespace

name - the name of the EndPoint

Returns:

the EndPoint

of

public static EndPoint of(String namespace,
                          String name,
                          Map<String,String> properties)

Return the EndPoint as defined by the provided namespace, name and properties.

Parameters:

namespace - the name of the namespace

name - the name of the EndPoint

properties - the properties of the EndPoint. e.g. location

Returns:

the EndPoint

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object