UserScheduleGetEventListRequest

Bases: OCIRequest

Get the list of events of a user schedule. The response is either a UserScheduleGetEventListResponse or an ErrorResponse.

Attributes:

user_id (str):

schedule_key (ScheduleKey):

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

@dataclass(kw_only=True)
class UserScheduleGetEventListRequest(OCIRequest):
    """Get the list of events of a user schedule.
        The response is either a UserScheduleGetEventListResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        schedule_key (ScheduleKey):

    """

    user_id: str = field(metadata={"alias": "userId"})

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

Responses

Bases: OCIDataResponse

Response to UserScheduleGetEventListRequest. The response contains a list of events.

Attributes:

event_name (Optional[List[str]]):

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

@dataclass(kw_only=True)
class UserScheduleGetEventListResponse(OCIDataResponse):
    """Response to UserScheduleGetEventListRequest.
        The response contains a list of events.

    Attributes:

        event_name (Optional[List[str]]):

    """

    event_name: Optional[List[str]] = field(
        default=None, metadata={"alias": "eventName"}
    )

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 UserScheduleGetEventListRequest

client = Client()

command = UserScheduleGetEventListRequest(
    user_id=...,
    schedule_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserScheduleGetEventListRequest",
    user_id=...,
    schedule_key=...,
)

print(response)