SystemDeviceFamilyModifyRequest

Bases: OCIRequest

Request to modify a device family. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

device_family_name (str):

new_device_family_name (Optional[str]):

device_type_list (Optional[Nillable[ReplacementDeviceTypeList]]):

tag_set_list (Optional[Nillable[ReplacementTagSetList]]):

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

@dataclass(kw_only=True)
class SystemDeviceFamilyModifyRequest(OCIRequest):
    """Request to modify a device family.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        device_family_name (str):

        new_device_family_name (Optional[str]):

        device_type_list (Optional[Nillable[ReplacementDeviceTypeList]]):

        tag_set_list (Optional[Nillable[ReplacementTagSetList]]):

    """

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

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

    device_type_list: Optional[Nillable[ReplacementDeviceTypeList]] = field(
        default=None, metadata={"alias": "deviceTypeList"}
    )

    tag_set_list: Optional[Nillable[ReplacementTagSetList]] = field(
        default=None, metadata={"alias": "tagSetList"}
    )

    def __post_init__(self):
        nillable_fields = ["device_type_list", "tag_set_list"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 SystemDeviceFamilyModifyRequest

client = Client()

command = SystemDeviceFamilyModifyRequest(
    device_family_name=...,
    new_device_family_name=...,
    device_type_list=...,
    tag_set_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceFamilyModifyRequest",
    device_family_name=...,
    new_device_family_name=...,
    device_type_list=...,
    tag_set_list=...,
)

print(response)