application.v1

zen_api.application.v1

Classes:

• CompositionServiceCreateModuleRequest –

  The CompositionServiceCreateModuleRequest class.

• CompositionServiceCreateModuleResponse –

  The CompositionServiceCreateModuleResponse class.

• CompositionServiceIsModuleAvailableRequest –

  The CompositionServiceIsModuleAvailableRequest class.

• IsModuleAvailableResponse –

  Response object of the method for checking the availability state of a composition module.

CompositionServiceCreateModuleRequest dataclass

CompositionServiceCreateModuleRequest(module_id: str = betterproto.string_field(1), display_name: str = betterproto.string_field(2), description: str = betterproto.string_field(3), license_string: str = betterproto.string_field(4), minimum_required_version: str = betterproto.string_field(5))

Bases: Message

The CompositionServiceCreateModuleRequest class.

Attributes:

• module_id (str) –

  The id of the module.

• display_name (str) –

  The display name of the module.

• description (str) –

  The description of the module.

• license_string (str) –

  The license string.

• minimum_required_version (str) –

  The minimum required feature version.

module_id class-attribute instance-attribute

module_id: str = string_field(1)

The id of the module.

display_name class-attribute instance-attribute

display_name: str = string_field(2)

The display name of the module.

description class-attribute instance-attribute

description: str = string_field(3)

The description of the module.

license_string class-attribute instance-attribute

license_string: str = string_field(4)

The license string.

minimum_required_version class-attribute instance-attribute

minimum_required_version: str = string_field(5)

The minimum required feature version.

CompositionServiceCreateModuleResponse dataclass

CompositionServiceCreateModuleResponse()

Bases: Message

The CompositionServiceCreateModuleResponse class.

CompositionServiceIsModuleAvailableRequest dataclass

CompositionServiceIsModuleAvailableRequest(module_id: str = betterproto.string_field(1))

Bases: Message

The CompositionServiceIsModuleAvailableRequest class.

Attributes:

• module_id (str) –

  The module id.

module_id class-attribute instance-attribute

module_id: str = string_field(1)

The module id.

IsModuleAvailableResponse dataclass

IsModuleAvailableResponse(is_available: bool = betterproto.bool_field(1))

Bases: Message

Response object of the method for checking the availability state of a composition module.

Attributes:

• is_available (bool) –

  A value indicating whether the module is available or not.

is_available class-attribute instance-attribute

is_available: bool = bool_field(1)

A value indicating whether the module is available or not.