com.linkedin.feathr.core.config.producer.sources

Class RestliConfig

java.lang.Object

com.linkedin.feathr.core.config.producer.sources.SourceConfig

com.linkedin.feathr.core.config.producer.sources.RestliConfig

All Implemented Interfaces:

ConfigObj, java.io.Serializable

public final class RestliConfig
extends SourceConfig

Represents the Rest.Li source config

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTITY_TYPE Deprecated. As of beta, this field is deprecated in favor of KEY_EXPR(keyExpr)
static java.lang.String	FILE
static java.lang.String	FINDER
static java.lang.String	JSON
static java.lang.String	JSON_ARRAY
static java.lang.String	JSON_ARRAY_ARRAY
static java.lang.String	KEY_EXPR
static java.lang.String	MVEL_KEY
static java.lang.String	PATH_SPEC
static java.lang.String	REQ_PARAMS
static java.lang.String	RESOUCE_NAME Deprecated. As of beta, the field name is a typo and will be removed
static java.lang.String	RESOURCE_NAME

Fields inherited from class com.linkedin.feathr.core.config.producer.sources.SourceConfig

_sourceName, TYPE

Constructor Summary

Constructors

Constructor and Description
RestliConfig(java.lang.String sourceName, java.lang.String resourceName, java.util.Map<java.lang.String,java.lang.Object> reqParams, com.linkedin.data.schema.PathSpec pathSpec, java.lang.String finder) Construct a finder based RestliConfig for non-association resources where there is no association key required
RestliConfig(java.lang.String sourceName, java.lang.String resourceName, java.lang.String keyExpr, java.util.Map<java.lang.String,java.lang.Object> reqParams, com.linkedin.data.schema.PathSpec pathSpec) Constructor with keyExpr only
RestliConfig(java.lang.String sourceName, java.lang.String resourceName, java.lang.String keyExpr, java.util.Map<java.lang.String,java.lang.Object> reqParams, com.linkedin.data.schema.PathSpec pathSpec, java.lang.String finder) Constructor for creating a new instance of RestliConfig with both keyExpr

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	getFinder()
java.lang.String	getKeyExpr() Deprecated. this might return null, please use getOptionalKeyExpr() instead
java.util.Optional<java.lang.String>	getOptionalKeyExpr()
java.util.Optional<com.linkedin.data.schema.PathSpec>	getPathSpec()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getReqParams()
java.lang.String	getResourceName()
SourceType	getSourceType()
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.linkedin.feathr.core.config.producer.sources.SourceConfig

getSourceName

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

RESOUCE_NAME

@Deprecated
public static final java.lang.String RESOUCE_NAME

Deprecated. As of beta, the field name is a typo and will be removed

See Also:

Constant Field Values

KEY_EXPR

public static final java.lang.String KEY_EXPR

See Also:

Constant Field Values

ENTITY_TYPE

@Deprecated
public static final java.lang.String ENTITY_TYPE

Deprecated. As of beta, this field is deprecated in favor of KEY_EXPR(keyExpr)

See Also:

Constant Field Values

REQ_PARAMS

public static final java.lang.String REQ_PARAMS

See Also:

Constant Field Values

PATH_SPEC

public static final java.lang.String PATH_SPEC

See Also:

Constant Field Values

FINDER

public static final java.lang.String FINDER

See Also:

Constant Field Values

JSON

public static final java.lang.String JSON

See Also:

Constant Field Values

JSON_ARRAY

public static final java.lang.String JSON_ARRAY

See Also:

Constant Field Values

JSON_ARRAY_ARRAY

public static final java.lang.String JSON_ARRAY_ARRAY

See Also:

Constant Field Values

MVEL_KEY

public static final java.lang.String MVEL_KEY

See Also:

Constant Field Values

FILE

public static final java.lang.String FILE

See Also:

Constant Field Values

Constructor Detail

RestliConfig

public RestliConfig(@Nonnull
                    java.lang.String sourceName,
                    @Nonnull
                    java.lang.String resourceName,
                    @Nonnull
                    java.lang.String keyExpr,
                    java.util.Map<java.lang.String,java.lang.Object> reqParams,
                    com.linkedin.data.schema.PathSpec pathSpec)

Constructor with keyExpr only

Parameters:

sourceName - the name of the source and it is referenced by the anchor in the feature definition

resourceName - Name of the Rest.Li resource

keyExpr - Key expression

reqParams - request parameters specified as a Map

pathSpec - PathSpec

RestliConfig

public RestliConfig(@Nonnull
                    java.lang.String sourceName,
                    @Nonnull
                    java.lang.String resourceName,
                    java.util.Map<java.lang.String,java.lang.Object> reqParams,
                    com.linkedin.data.schema.PathSpec pathSpec,
                    @Nonnull
                    java.lang.String finder)

Construct a finder based RestliConfig for non-association resources where there is no association key required

Parameters:

sourceName - the name of the source and it is referenced by the anchor in the feature definition

resourceName - Name of the Rest.Li resource

reqParams - request parameters specified as a Map

pathSpec - PathSpec

finder - the finder method name of the resource.

RestliConfig

public RestliConfig(java.lang.String sourceName,
                    java.lang.String resourceName,
                    java.lang.String keyExpr,
                    java.util.Map<java.lang.String,java.lang.Object> reqParams,
                    com.linkedin.data.schema.PathSpec pathSpec,
                    java.lang.String finder)

Constructor for creating a new instance of RestliConfig with both keyExpr

Parameters:

sourceName - the name of the source and it is referenced by the anchor in the feature definition

keyExpr - Key expression for the resource.

resourceName - Name of the Rest.Li resource

reqParams - request parameters specified as a Map

pathSpec - PathSpec

finder - the finder method name of the resource.

Method Detail

getResourceName

public java.lang.String getResourceName()

getKeyExpr

@Deprecated
public java.lang.String getKeyExpr()

Deprecated. this might return null, please use getOptionalKeyExpr() instead

getOptionalKeyExpr

public java.util.Optional<java.lang.String> getOptionalKeyExpr()

getReqParams

public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getReqParams()

getPathSpec

public java.util.Optional<com.linkedin.data.schema.PathSpec> getPathSpec()

getFinder

public java.util.Optional<java.lang.String> getFinder()

getSourceType

public SourceType getSourceType()

Specified by:

getSourceType in class SourceConfig

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class SourceConfig

hashCode

public int hashCode()

Overrides:

hashCode in class SourceConfig

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object