GroupAccessDeviceGetLinkedTreeDeviceRequest

Bases: OCIRequest

Requests the tree device linked with the group level leaf 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 response is either GroupAccessDeviceGetLinkedTreeDeviceResponse or
ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

device_name (str):

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

@dataclass(kw_only=True)
class GroupAccessDeviceGetLinkedTreeDeviceRequest(OCIRequest):
    """Requests the tree device linked with the group level leaf 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 response is either GroupAccessDeviceGetLinkedTreeDeviceResponse or
        ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_name (str):

    """

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

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

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

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceGetLinkedTreeDeviceRequest.

Attributes:

tree_device_info (Optional[TreeDeviceInfo]):

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

@dataclass(kw_only=True)
class GroupAccessDeviceGetLinkedTreeDeviceResponse(OCIDataResponse):
    """Response to GroupAccessDeviceGetLinkedTreeDeviceRequest.

    Attributes:

        tree_device_info (Optional[TreeDeviceInfo]):

    """

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

Bases: OCIResponse

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

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

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupAccessDeviceGetLinkedTreeDeviceRequest

client = Client()

command = GroupAccessDeviceGetLinkedTreeDeviceRequest(
    service_provider_id=...,
    group_id=...,
    device_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

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

print(response)