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

Attribute	Type	Description
app_name	str	The name of the upstream app whose endpoint is being requested as a dependency.
public	bool = False	Determines whether to retrieve the public URL via the remote App object or construct a private URL using environment variables.
type	Literal["string"] = "string"	The data format of the parameter, restricted to a literal string value.

---

Constructor

Signature

def AppEndpoint(
    app_name: str,
    public: bool = False,
    type: Literal["string"] = "string"
) - > null

Parameters

Name	Type	Description
app_name	str	The name of the upstream app to retrieve the endpoint from.
public	bool = False	Whether to retrieve the public URL (True) or the private URL (False).
type	Literal["string"] = "string"	The data type of the parameter, defaults to 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

Type	Description
[AppEndpoint](appendpoint.md?sid=flyte_app__parameter_appendpoint)	The AppEndpoint instance itself, prepared for serving-time resolution

---