Skip to content

SystemScheduleGetEventRequest

Bases: OCIRequest

Get an event from a system schedule. The response is either a SystemScheduleGetEventResponse or an ErrorResponse.

Attributes:

schedule_key (ScheduleKey):

event_name (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemScheduleGetEventRequest(OCIRequest):
    """Get an event from a system schedule.
        The response is either a SystemScheduleGetEventResponse or an ErrorResponse.

    Attributes:

        schedule_key (ScheduleKey):

        event_name (str):

    """

    schedule_key: ScheduleKey = field(metadata={"alias": "scheduleKey"})

    event_name: str = field(metadata={"alias": "eventName"})

Responses

Bases: OCIDataResponse

Response to SystemScheduleGetEventRequest. The response contains the event of the system schedulable.

Attributes:

start_date (int):

all_day_event (Optional[bool]):

start_time (Optional[HourMinute]):

end_time (Optional[HourMinute]):

end_date (int):

recurrence (Optional[Recurrence]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemScheduleGetEventResponse(OCIDataResponse):
    """Response to SystemScheduleGetEventRequest.
        The response contains the event of the system schedulable.

    Attributes:

        start_date (int):

        all_day_event (Optional[bool]):

        start_time (Optional[HourMinute]):

        end_time (Optional[HourMinute]):

        end_date (int):

        recurrence (Optional[Recurrence]):

    """

    start_date: int = field(metadata={"alias": "startDate"})

    all_day_event: Optional[bool] = field(
        default=None, metadata={"alias": "allDayEvent"}
    )

    start_time: Optional[HourMinute] = field(
        default=None, metadata={"alias": "startTime"}
    )

    end_time: Optional[HourMinute] = field(default=None, metadata={"alias": "endTime"})

    end_date: int = field(metadata={"alias": "endDate"})

    recurrence: Optional[Recurrence] = field(
        default=None, metadata={"alias": "recurrence"}
    )

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 SystemScheduleGetEventRequest

client = Client()

command = SystemScheduleGetEventRequest(
    schedule_key=...,
    event_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemScheduleGetEventRequest",
    schedule_key=...,
    event_name=...,
)

print(response)