SystemDeviceFamilyGetRequest

Bases: OCIRequest

Request to get the associated device types and tagsets for a given device family.

The response is either SystemDeviceFamilyGetResponse or ErrorResponse.

Attributes:

device_family_name (str):

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

@dataclass(kw_only=True)
class SystemDeviceFamilyGetRequest(OCIRequest):
    """Request to get the associated device types and tagsets for a given device family.

        The response is either SystemDeviceFamilyGetResponse or ErrorResponse.

    Attributes:

        device_family_name (str):

    """

    device_family_name: str = field(metadata={"alias": "deviceFamilyName"})

Responses

Bases: OCIDataResponse

Response to SystemDeviceFamilyGetRequest. The response includes the tag sets and device types associated to a device family defined in the system. Column headings for deviceTypeTable are : Device Type(s) Column headings for tagSetTable are :Tag Set(s)

Attributes:

device_type_table (OCITable):

tag_set_table (OCITable):

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

@dataclass(kw_only=True)
class SystemDeviceFamilyGetResponse(OCIDataResponse):
    """Response to SystemDeviceFamilyGetRequest.
        The response includes the tag sets and device types associated to a device family defined in the system.
        Column headings for deviceTypeTable are : Device Type(s)
        Column headings for tagSetTable are :Tag Set(s)

    Attributes:

        device_type_table (OCITable):

        tag_set_table (OCITable):

    """

    device_type_table: OCITable = field(metadata={"alias": "deviceTypeTable"})

    tag_set_table: OCITable = field(metadata={"alias": "tagSetTable"})

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 SystemDeviceFamilyGetRequest

client = Client()

command = SystemDeviceFamilyGetRequest(
    device_family_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceFamilyGetRequest",
    device_family_name=...,
)

print(response)