GroupAccessDeviceGetLinkedLeafDeviceListRequest22

Bases: OCIRequest

Requests the list of linked leaf devices for the group level tree device passed in the request. A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All".

The response is either GroupAccessDeviceGetLinkedLeafDeviceListResponse22 or
ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

device_name (str):

leaf_device_category (Optional[str]):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class GroupAccessDeviceGetLinkedLeafDeviceListRequest22(OCIRequest):
    """Requests the list of linked leaf devices for the group level tree device passed in the request.
        A tree device is a device associated with a device type that has the option
        supportLinks set to \"Support Links from Devices\". Many leaf devices can be linked to it.
        A leaf device is a device associated with a device type that has the option
        supportLinks set to \"Support Link to Device\" or \"Support Link to Device and User\".  It can
        be linked to only one tree device.
        The list includes devices created at the system, service provider, and group levels.
        If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested.
        The category values are: \"Handset\", \"Base Station\", \"All\".

        The response is either GroupAccessDeviceGetLinkedLeafDeviceListResponse22 or
        ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_name (str):

        leaf_device_category (Optional[str]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    device_name: str = field(metadata={"alias": "deviceName"})

    leaf_device_category: Optional[str] = field(
        default=None, metadata={"alias": "leafDeviceCategory"}
    )

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceGetLinkedLeafDeviceListRequest22.

Attributes:

tree_device_link_id (str):

leaf_device_key (Optional[List[AccessDeviceKey]]):

support_links (Optional[List[str]]):

Source code in src/mercury_ocip_fast/commands/commands.py

@dataclass(kw_only=True)
class GroupAccessDeviceGetLinkedLeafDeviceListResponse22(OCIDataResponse):
    """Response to GroupAccessDeviceGetLinkedLeafDeviceListRequest22.

    Attributes:

        tree_device_link_id (str):

        leaf_device_key (Optional[List[AccessDeviceKey]]):

        support_links (Optional[List[str]]):

    """

    tree_device_link_id: str = field(metadata={"alias": "treeDeviceLinkId"})

    leaf_device_key: Optional[List[AccessDeviceKey]] = field(
        default=None, metadata={"alias": "leafDeviceKey"}
    )

    support_links: Optional[List[str]] = field(
        default=None, metadata={"alias": "supportLinks"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupAccessDeviceGetLinkedLeafDeviceListRequest22

client = Client()

command = GroupAccessDeviceGetLinkedLeafDeviceListRequest22(
    service_provider_id=...,
    group_id=...,
    device_name=...,
    leaf_device_category=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceGetLinkedLeafDeviceListRequest22",
    service_provider_id=...,
    group_id=...,
    device_name=...,
    leaf_device_category=...,
)

print(response)