mlrun.common.schemas.api_gateway

class mlrun.common.schemas.api_gateway.APIGateway(*, metadata: APIGatewayMetadata, spec: APIGatewaySpec, status: APIGatewayStatus | None = None, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

enrich_mlrun_names()

get_function_names()

get_invoke_url()

metadata: APIGatewayMetadata

replace_nuclio_names_with_mlrun_names()

spec: APIGatewaySpec

status: APIGatewayStatus | None

class mlrun.common.schemas.api_gateway.APIGatewayAuthenticationMode(value)

Bases: StrEnum

An enumeration.

access_key = 'accessKey'

basic = 'basicAuth'

classmethod from_str(authentication_mode: str)

none = 'none'

class mlrun.common.schemas.api_gateway.APIGatewayBasicAuth(*, username: str, password: str, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

password: str

username: str

class mlrun.common.schemas.api_gateway.APIGatewayMetadata(*, name: str, namespace: str | None = None, labels: dict | None = {}, annotations: dict | None = {}, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

annotations: dict | None

labels: dict | None

name: str

namespace: str | None

class mlrun.common.schemas.api_gateway.APIGatewaySpec(*, name: str, description: str | None = None, path: str | None = '/', authenticationMode: APIGatewayAuthenticationMode | None = APIGatewayAuthenticationMode.none, upstreams: list[mlrun.common.schemas.api_gateway.APIGatewayUpstream], authentication: dict[str, Optional[mlrun.common.schemas.api_gateway.APIGatewayBasicAuth]] | None = None, host: str | None = None, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

authentication: dict[str, Optional[mlrun.common.schemas.api_gateway.APIGatewayBasicAuth]] | None

authenticationMode: APIGatewayAuthenticationMode | None

description: str | None

host: str | None

name: str

path: str | None

upstreams: list[mlrun.common.schemas.api_gateway.APIGatewayUpstream]

class mlrun.common.schemas.api_gateway.APIGatewayState(value)

Bases: StrEnum

An enumeration.

error = 'error'

none = ''

ready = 'ready'

waiting_for_provisioning = 'waitingForProvisioning'

class mlrun.common.schemas.api_gateway.APIGatewayStatus(*, name: str | None = None, state: APIGatewayState | None = None, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

name: str | None

state: APIGatewayState | None

class mlrun.common.schemas.api_gateway.APIGatewayUpstream(*, kind: str | None = 'nucliofunction', nucliofunction: dict[str, str], percentage: int | None = 0, port: int | None = 0, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

kind: str | None

nucliofunction: dict[str, str]

percentage: int | None

port: int | None

class mlrun.common.schemas.api_gateway.APIGatewaysOutput(*, api_gateways: dict[str, mlrun.common.schemas.api_gateway.APIGateway] | None = {}, **extra_data: Any)

Bases: _APIGatewayBaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

api_gateways: dict[str, mlrun.common.schemas.api_gateway.APIGateway] | None