SystemDeviceManagementInProgressAndPendingEventCancelRequest

Bases: OCIRequest

Cancel pending and in progress events. Either all events, multiple events, or a list of specified events can be canceled. When specifying multiple events, an event must meet all specified criteria to be canceled. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

cancel_all_events (Optional[Any]):

cancel_multiple_events (Optional[object]):

event_id (Optional[List[int]]):

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

@dataclass(kw_only=True)
class SystemDeviceManagementInProgressAndPendingEventCancelRequest(OCIRequest):
    """Cancel pending and in progress events.  Either all events, multiple
      events, or a list of specified events can be canceled.
      When specifying multiple events, an event must meet all specified
      criteria to be canceled.
      The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        cancel_all_events (Optional[Any]):

        cancel_multiple_events (Optional[object]):

        event_id (Optional[List[int]]):

    """

    cancel_all_events: Optional[Any] = field(
        default=None, metadata={"alias": "cancelAllEvents"}
    )

    cancel_multiple_events: Optional[object] = field(
        default=None, metadata={"alias": "cancelMultipleEvents"}
    )

    event_id: Optional[List[int]] = field(default=None, metadata={"alias": "eventId"})

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 SystemDeviceManagementInProgressAndPendingEventCancelRequest

client = Client()

command = SystemDeviceManagementInProgressAndPendingEventCancelRequest(
    cancel_all_events=...,
    cancel_multiple_events=...,
    event_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("SystemDeviceManagementInProgressAndPendingEventCancelRequest",
    cancel_all_events=...,
    cancel_multiple_events=...,
    event_id=...,
)

print(response)