kfp.dsl.types module

class kfp.dsl.types.BaseType[source]

Bases: object

MetaType is a base type for all scalar and artifact types.

class kfp.dsl.types.Bool[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'boolean'}
class kfp.dsl.types.Dict[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'object'}
class kfp.dsl.types.Float[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'number'}
class kfp.dsl.types.GCPProjectID[source]

Bases: kfp.dsl.types.BaseType

MetaGCPProjectID: GCP project id

openapi_schema_validator = {'type': 'string'}
class kfp.dsl.types.GCPRegion[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'string'}
class kfp.dsl.types.GCRPath[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'pattern': '^.*gcr\\.io/.*$', 'type': 'string'}
class kfp.dsl.types.GCSPath[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'pattern': '^gs://.*$', 'type': 'string'}
exception kfp.dsl.types.InconsistentTypeException[source]

Bases: Exception

InconsistencyTypeException is raised when two types are not consistent

class kfp.dsl.types.Integer[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'integer'}
class kfp.dsl.types.List[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'array'}
class kfp.dsl.types.LocalPath[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'string'}
class kfp.dsl.types.String[source]

Bases: kfp.dsl.types.BaseType

openapi_schema_validator = {'type': 'string'}
kfp.dsl.types.check_types(checked_type, expected_type)[source]

check_types checks the type consistency. For each of the attribute in checked_type, there is the same attribute in expected_type with the same value. However, expected_type could contain more attributes that checked_type does not contain. :param checked_type: it describes a type from the upstream component output :type checked_type: BaseType/str/dict :param expected_type: it describes a type from the downstream component input :type expected_type: BaseType/str/dict