BasegnodesGet

Python pydantic class corresponding to json type `basegnodes.get`.

class gnf.types.BasegnodesGet(*, TopGNodeAlias, IncludeAllDescendants, FromGNodeAlias, FromGNodeInstanceId, TypeName='basegnodes.get', Version='000')

Parameters:

• TopGNodeAlias (str) –

• IncludeAllDescendants (bool) –

• FromGNodeAlias (str) –

• FromGNodeInstanceId (str) –

• TypeName (Literal['basegnodes.get']) –

• Version (str) –

TopGNodeAlias:

• Description:

• Format: LeftRightDot

IncludeAllDescendants:

• Description:

FromGNodeAlias:

• Description:

• Format: LeftRightDot

FromGNodeInstanceId:

• Description:

• Format: UuidCanonicalTextual

class gnf.types.basegnodes_get.check_is_uuid_canonical_textual(v)

UuidCanonicalTextual format: A string of hex words separated by hyphens of length 8-4-4-4-12.

Raises:

ValueError – if not UuidCanonicalTextual format

Parameters:

v (str) –

class gnf.types.basegnodes_get.check_is_left_right_dot(v)

LeftRightDot format: Lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character.

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gnf.types.BasegnodesGet_Maker(top_g_node_alias, include_all_descendants, from_g_node_alias, from_g_node_instance_id)

Parameters:

• top_g_node_alias (str) –

• include_all_descendants (bool) –

• from_g_node_alias (str) –

• from_g_node_instance_id (str) –

classmethod tuple_to_type(tuple)

Given a Python class object, returns the serialized JSON type object

Parameters:

tuple (BasegnodesGet) –

Return type:

str

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object

Parameters:

t (str) –

Return type:

BasegnodesGet