ServiceProviderGetAvailableTreeDeviceListRequest

Bases: OCIRequest

Requests the list of available tree devices to which a leaf device can be linked to within a specific service provider. 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 ServiceProviderGetAvailableTreeDeviceListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

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

@dataclass(kw_only=True)
class ServiceProviderGetAvailableTreeDeviceListRequest(OCIRequest):
    """Requests the list of available tree devices to which a leaf device can be linked to within a specific service provider.
        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 ServiceProviderGetAvailableTreeDeviceListResponse or
        ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to ServiceProviderGetAvailableTreeDeviceListRequest.

Attributes:

tree_device_info (Optional[List[TreeDeviceInfo]]):

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

@dataclass(kw_only=True)
class ServiceProviderGetAvailableTreeDeviceListResponse(OCIDataResponse):
    """Response to ServiceProviderGetAvailableTreeDeviceListRequest.

    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/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 ServiceProviderGetAvailableTreeDeviceListRequest

client = Client()

command = ServiceProviderGetAvailableTreeDeviceListRequest(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderGetAvailableTreeDeviceListRequest",
    service_provider_id=...,
)

print(response)