GroupGetAvailableTreeDeviceListRequest

Bases: OCIRequest

Requests the list of available tree devices to which leaf devices can be linked to within a specific group. 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. The list returned includes devices created at the system, service provider, and group levels. The response is either GroupGetAvailableTreeDeviceListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

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

@dataclass(kw_only=True)
class GroupGetAvailableTreeDeviceListRequest(OCIRequest):
    """Requests the list of available tree devices to which leaf devices can be linked to within a specific group.
        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.
        The list returned includes devices created at the system, service provider, and group levels.
        The response is either GroupGetAvailableTreeDeviceListResponse or
        ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

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

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

Responses

Bases: OCIDataResponse

Response to GroupGetAvailableTreeDeviceListRequest.

Attributes:

tree_device_info (Optional[List[TreeDeviceInfo]]):

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

@dataclass(kw_only=True)
class GroupGetAvailableTreeDeviceListResponse(OCIDataResponse):
    """Response to GroupGetAvailableTreeDeviceListRequest.

    Attributes:

        tree_device_info (Optional[List[TreeDeviceInfo]]):

    """

    tree_device_info: Optional[List[TreeDeviceInfo]] = field(
        default=None, metadata={"alias": "treeDeviceInfo"}
    )

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 GroupGetAvailableTreeDeviceListRequest

client = Client()

command = GroupGetAvailableTreeDeviceListRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupGetAvailableTreeDeviceListRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)