GroupAccessDeviceDeleteRequest

Bases: OCIRequest

Request to delete a specified group access device.

The following elements are only used in AS data mode and ignored in XS data mode:
  deviceExternalId

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (Optional[str]):

group_id (Optional[str]):

device_name (Optional[str]):

device_external_id (Optional[str]):

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

@dataclass(kw_only=True)
class GroupAccessDeviceDeleteRequest(OCIRequest):
    """Request to delete a specified group access device.

        The following elements are only used in AS data mode and ignored in XS data mode:
          deviceExternalId

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

        device_name (Optional[str]):

        device_external_id (Optional[str]):

    """

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

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

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

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

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

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

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

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupAccessDeviceDeleteRequest

client = Client()

command = GroupAccessDeviceDeleteRequest(
    service_provider_id=...,
    group_id=...,
    device_name=...,
    device_external_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)