Skip to main content

AppEndpoint

Embed an upstream app's endpoint as an app parameter. This enables the declaration of an app parameter dependency on a the endpoint of an upstream app, given by a specific app name. This gives the app access to the upstream app's endpoint as a public or private url.

Attributes

AttributeTypeDescription
app_namestrThe name of the upstream app whose endpoint is being embedded.
publicbool = FalseA boolean indicating whether the endpoint should be public or private; if true, the endpoint is retrieved from the App object, otherwise, it's constructed using an internal pattern.
typeLiteral["string"] = "string"A literal string indicating the type of the endpoint, which is always "string".

Methods


materialize()

@classmethod
def materialize() - > [AppEndpoint](appendpoint.md?sid=flyte_app__parameter_appendpoint)

Returns the AppEndpoint object, the endpoint is retrieved at serving time by the fserve executable.

Returns

TypeDescription
[AppEndpoint](appendpoint.md?sid=flyte_app__parameter_appendpoint)The AppEndpoint object itself.