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.
-
CompositionServiceStub– -
CompositionServiceBase–
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.
class-attribute
instance-attribute
#
module_id: str = betterproto.string_field(1)
The id of the module.
class-attribute
instance-attribute
#
display_name: str = betterproto.string_field(2)
The display name of the module.
class-attribute
instance-attribute
#
description: str = betterproto.string_field(3)
The description of the module.
class-attribute
instance-attribute
#
license_string: str = betterproto.string_field(4)
The license string.
class-attribute
instance-attribute
#
minimum_required_version: str = betterproto.string_field(5)
The minimum required feature version.
dataclass
#
CompositionServiceCreateModuleResponse()
Bases: Message
The CompositionServiceCreateModuleResponse class.
dataclass
#
CompositionServiceIsModuleAvailableRequest(module_id: str = betterproto.string_field(1))
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.
class-attribute
instance-attribute
#
is_available: bool = betterproto.bool_field(1)
A value indicating whether the module is available or not.
Bases: ServiceStub
Methods:
-
create_module–Creates a module and adds it to the selected profile.
-
is_module_available–Returns the availability state of the given module.
async
#
create_module(composition_service_create_module_request: CompositionServiceCreateModuleRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CompositionServiceCreateModuleResponse
Creates a module and adds it to the selected profile. With this method, a client can 'inject' a new module at runtime (e.g. via OAD script or ZEN API). After adding the module, it will appear as optional module of the selected profile just as any other module. The Module Manager can be used to verify this. After adding the module, the client can make use of the 'normal' license infrastructure to check the avaiability of the newly added module. Note: A module is available, if the module is licensed AND the user has enabled it (via the Module Manager). In case a module gets added via this method, the module is enabled by default.
async
#
is_module_available(composition_service_is_module_available_request: CompositionServiceIsModuleAvailableRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> IsModuleAvailableResponse
Returns the availability state of the given module.
Bases: ServiceBase
Methods:
-
create_module–Creates a module and adds it to the selected profile.
-
is_module_available–Returns the availability state of the given module.
async
#
create_module(composition_service_create_module_request: CompositionServiceCreateModuleRequest) -> CompositionServiceCreateModuleResponse
Creates a module and adds it to the selected profile. With this method, a client can 'inject' a new module at runtime (e.g. via OAD script or ZEN API). After adding the module, it will appear as optional module of the selected profile just as any other module. The Module Manager can be used to verify this. After adding the module, the client can make use of the 'normal' license infrastructure to check the avaiability of the newly added module. Note: A module is available, if the module is licensed AND the user has enabled it (via the Module Manager). In case a module gets added via this method, the module is enabled by default.
async
#
is_module_available(composition_service_is_module_available_request: CompositionServiceIsModuleAvailableRequest) -> IsModuleAvailableResponse
Returns the availability state of the given module.