File: _models.py

package info (click to toggle)
python-azure 20250829%2Bgit-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 756,824 kB
  • sloc: python: 6,224,989; ansic: 804; javascript: 287; makefile: 198; sh: 195; xml: 109
file content (141 lines) | stat: -rw-r--r-- 4,593 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) Python Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=useless-super-delegation

from typing import Any, List, Mapping, Optional, overload

from .._utils.model_base import Model as _Model, rest_field


class AddToGroupsRequest(_Model):
    """Request object to add connections to groups.

    :ivar groups: Target groups.
    :vartype groups: list[str]
    :ivar filter: Following OData filter syntax to filter out the subscribers receiving the
     messages.
    :vartype filter: str
    """

    groups: Optional[List[str]] = rest_field(visibility=["read", "create", "update", "delete", "query"])
    """Target groups."""
    filter: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"])
    """Following OData filter syntax to filter out the subscribers receiving the messages."""

    @overload
    def __init__(
        self,
        *,
        groups: Optional[List[str]] = None,
        filter: Optional[str] = None,  # pylint: disable=redefined-builtin
    ) -> None: ...

    @overload
    def __init__(self, mapping: Mapping[str, Any]) -> None:
        """
        :param mapping: raw JSON to initialize the model.
        :type mapping: Mapping[str, Any]
        """

    def __init__(self, *args: Any, **kwargs: Any) -> None:
        super().__init__(*args, **kwargs)


class ClientTokenResponse(_Model):
    """The response object containing the client access token.

    :ivar token: Access token for the client to connect Azure Web PubSub service.
    :vartype token: str
    """

    token: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"])
    """Access token for the client to connect Azure Web PubSub service."""

    @overload
    def __init__(
        self,
        *,
        token: Optional[str] = None,
    ) -> None: ...

    @overload
    def __init__(self, mapping: Mapping[str, Any]) -> None:
        """
        :param mapping: raw JSON to initialize the model.
        :type mapping: Mapping[str, Any]
        """

    def __init__(self, *args: Any, **kwargs: Any) -> None:
        super().__init__(*args, **kwargs)


class GroupMember(_Model):
    """Group member.

    :ivar connection_id: Connection Id. Required.
    :vartype connection_id: str
    :ivar user_id: User Id.
    :vartype user_id: str
    """

    connection_id: str = rest_field(name="connectionId", visibility=["read", "create", "update", "delete", "query"])
    """Connection Id. Required."""
    user_id: Optional[str] = rest_field(name="userId", visibility=["read", "create", "update", "delete", "query"])
    """User Id."""

    @overload
    def __init__(
        self,
        *,
        connection_id: str,
        user_id: Optional[str] = None,
    ) -> None: ...

    @overload
    def __init__(self, mapping: Mapping[str, Any]) -> None:
        """
        :param mapping: raw JSON to initialize the model.
        :type mapping: Mapping[str, Any]
        """

    def __init__(self, *args: Any, **kwargs: Any) -> None:
        super().__init__(*args, **kwargs)


class RemoveFromGroupsRequest(_Model):
    """Request object to remove connections from groups.

    :ivar groups: Target groups.
    :vartype groups: list[str]
    :ivar filter: Following OData filter syntax to filter out the subscribers receiving the
     messages.
    :vartype filter: str
    """

    groups: Optional[List[str]] = rest_field(visibility=["read", "create", "update", "delete", "query"])
    """Target groups."""
    filter: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"])
    """Following OData filter syntax to filter out the subscribers receiving the messages."""

    @overload
    def __init__(
        self,
        *,
        groups: Optional[List[str]] = None,
        filter: Optional[str] = None,  # pylint: disable=redefined-builtin
    ) -> None: ...

    @overload
    def __init__(self, mapping: Mapping[str, Any]) -> None:
        """
        :param mapping: raw JSON to initialize the model.
        :type mapping: Mapping[str, Any]
        """

    def __init__(self, *args: Any, **kwargs: Any) -> None:
        super().__init__(*args, **kwargs)