websocket

Serializable websocket API request and response contracts.

class bedrock_server_manager.api.models.websocket.BroadcastRequest(*, topic: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], data: JsonValue)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.BroadcastResponse(*, status: Literal['success', 'skipped', 'partial']='success', message: str, delivery: DeliveryResult = <factory>)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.SendToUserRequest(*, username: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], data: JsonValue)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.SendToUserResponse(*, status: Literal['success', 'skipped', 'partial']='success', message: str, delivery: DeliveryResult = <factory>)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.SendToClientRequest(*, client_id: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], data: JsonValue)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.SendToClientResponse(*, status: Literal['success', 'skipped', 'partial']='success', message: str, delivery: DeliveryResult = <factory>)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.UnregisterDataProviderRequest(*, topic: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.UnregisterDataProviderResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, outcome: Literal['removed', 'already_absent'])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.PublishWsEventRequest(*, event_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], data: JsonValue)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.websocket.PublishWsEventResponse(*, status: Literal['success', 'skipped', 'partial']='success', message: str, delivery: DeliveryResult = <factory>)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].