unreal.WebAPIService
¶
- class unreal.WebAPIService(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
WebAPIModelBase
A service generally contains a sub-section of the API containing operations related to a particular subject.
C++ Source:
Plugin: WebAPI
Module: WebAPIEditor
File: WebAPIService.h
Editor Properties: (see get_editor_property/set_editor_property)
description
(str): [Read-Only] Describes this model.generate
(bool): [Read-Write] Can be disabled to skip generation of this Service and it’s operations.is_read_only
(bool): [Read-Only] By default all properties are read & write.is_required
(bool): [Read-Only] By default all properties are optional.maximum_value
(double): [Read-Only] Maximum value. Can also indicate maximum string length.minimum_value
(double): [Read-Only] Minimum value. Can also indicate minimum string length.name
(WebAPITypeNameVariant): [Read-Write] Name of the Service.operations
(Array[WebAPIOperation]): [Read-Write] Operations contained within the service.pattern
(str): [Read-Only] Regex Pattern to validate against.use_maximum_value
(bool): [Read-Only] Whether to use Maximum value.use_minimum_value
(bool): [Read-Only] Whether to use Minimum value.use_pattern
(bool): [Read-Only] Whether to use a Regex Pattern for validation.