ServiceProviderGetAvailableLeafDeviceListRequest22

Bases: OCIRequest

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

Attributes:

service_provider_id (str):

leaf_device_category (Optional[str]):

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

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

    Attributes:

        service_provider_id (str):

        leaf_device_category (Optional[str]):

    """

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

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

Responses

Bases: OCIDataResponse

Response to ServiceProviderGetAvailableLeafDeviceListRequest22.

Attributes:

leaf_device_key (Optional[List[AccessDeviceKey]]):

support_links (Optional[List[str]]):

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

@dataclass(kw_only=True)
class ServiceProviderGetAvailableLeafDeviceListResponse22(OCIDataResponse):
    """Response to ServiceProviderGetAvailableLeafDeviceListRequest22.

    Attributes:

        leaf_device_key (Optional[List[AccessDeviceKey]]):

        support_links (Optional[List[str]]):

    """

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

client = Client()

command = ServiceProviderGetAvailableLeafDeviceListRequest22(
    service_provider_id=...,
    leaf_device_category=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderGetAvailableLeafDeviceListRequest22",
    service_provider_id=...,
    leaf_device_category=...,
)

print(response)