Skip to content

GroupDeviceManagementEventGetListRequest22

Bases: OCIRequest

Request device management's events for a specific queue. It is possible to restrict the number of rows returned using responseSizeLimit. If eventQueueType is not specified, the events from all the event queues are returned. The response is either a GroupDeviceManagementEventGetListResponse22 or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

event_queue_type (Optional[str]):

response_size_limit (Optional[int]):

search_criteria_exact_device_management_event_status_in_progress_or_pending (Optional[SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending]):

search_criteria_exact_device_management_event_status_completed (Optional[SearchCriteriaExactDeviceManagementEventStatusCompleted]):

search_criteria_exact_device_management_event_action (Optional[SearchCriteriaExactDeviceManagementEventAction]):

search_criteria_exact_device_management_event_level (Optional[SearchCriteriaExactDeviceManagementEventLevel]):

search_criteria_exact_device_management_event_type (Optional[SearchCriteriaExactDeviceManagementEventType]):

search_criteria_device_management_event_additional_info (Optional[List[SearchCriteriaDeviceManagementEventAdditionalInfo]]):

search_criteria_device_management_event_login_id (Optional[List[SearchCriteriaDeviceManagementEventLoginId]]):

search_criteria_device_management_event_request (Optional[List[SearchCriteriaDeviceManagementEventRequest]]):

search_criteria_device_management_event_request_tracking_id (Optional[List[SearchCriteriaDeviceManagementEventRequestTrackingId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupDeviceManagementEventGetListRequest22(OCIRequest):
    """Request device management's events for a specific queue.
        It is possible to restrict the number of rows returned using
        responseSizeLimit.
        If eventQueueType is not specified, the events from all the
        event queues are returned.
        The response is either a GroupDeviceManagementEventGetListResponse22 or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        event_queue_type (Optional[str]):

        response_size_limit (Optional[int]):

        search_criteria_exact_device_management_event_status_in_progress_or_pending (Optional[SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending]):

        search_criteria_exact_device_management_event_status_completed (Optional[SearchCriteriaExactDeviceManagementEventStatusCompleted]):

        search_criteria_exact_device_management_event_action (Optional[SearchCriteriaExactDeviceManagementEventAction]):

        search_criteria_exact_device_management_event_level (Optional[SearchCriteriaExactDeviceManagementEventLevel]):

        search_criteria_exact_device_management_event_type (Optional[SearchCriteriaExactDeviceManagementEventType]):

        search_criteria_device_management_event_additional_info (Optional[List[SearchCriteriaDeviceManagementEventAdditionalInfo]]):

        search_criteria_device_management_event_login_id (Optional[List[SearchCriteriaDeviceManagementEventLoginId]]):

        search_criteria_device_management_event_request (Optional[List[SearchCriteriaDeviceManagementEventRequest]]):

        search_criteria_device_management_event_request_tracking_id (Optional[List[SearchCriteriaDeviceManagementEventRequestTrackingId]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

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

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_exact_device_management_event_status_in_progress_or_pending: Optional[
        SearchCriteriaExactDeviceManagementEventStatusInProgressOrPending
    ] = field(
        default=None,
        metadata={
            "alias": "searchCriteriaExactDeviceManagementEventStatusInProgressOrPending"
        },
    )

    search_criteria_exact_device_management_event_status_completed: Optional[
        SearchCriteriaExactDeviceManagementEventStatusCompleted
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaExactDeviceManagementEventStatusCompleted"},
    )

    search_criteria_exact_device_management_event_action: Optional[
        SearchCriteriaExactDeviceManagementEventAction
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaExactDeviceManagementEventAction"},
    )

    search_criteria_exact_device_management_event_level: Optional[
        SearchCriteriaExactDeviceManagementEventLevel
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaExactDeviceManagementEventLevel"},
    )

    search_criteria_exact_device_management_event_type: Optional[
        SearchCriteriaExactDeviceManagementEventType
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactDeviceManagementEventType"}
    )

    search_criteria_device_management_event_additional_info: Optional[
        List[SearchCriteriaDeviceManagementEventAdditionalInfo]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaDeviceManagementEventAdditionalInfo"},
    )

    search_criteria_device_management_event_login_id: Optional[
        List[SearchCriteriaDeviceManagementEventLoginId]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceManagementEventLoginId"}
    )

    search_criteria_device_management_event_request: Optional[
        List[SearchCriteriaDeviceManagementEventRequest]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceManagementEventRequest"}
    )

    search_criteria_device_management_event_request_tracking_id: Optional[
        List[SearchCriteriaDeviceManagementEventRequestTrackingId]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaDeviceManagementEventRequestTrackingId"},
    )

Responses

Bases: OCIDataResponse

Response to GroupDeviceManagementEventGetListRequest22. Contains a table with column headings: "Event Id", "Status", "Action", "Level", "Type", "Additional Info", "Is Local", "Completion %", "Pushed/ Same Hash/ Not Pushed", "Login Id", "Start Time", "Process Time", "Rx Time", "Total Time", "Request", "Priority", "Tracking Id", "End Time". "Event Id" is a unique identifier for the event. "Status" can be: Pending, Queued, In Progress, Process On Other Host, Stale, Completed, Canceled. "Action" can be: Delete, Download, Rebuild, Reset, Upload. "Level" can be: Device, Device Type, Device Type Group, Group, User. "Type" can be: Automatic, Manual. "Additional Info" includes the affected device type, device or group. It depends on the level of the event: Device Profile: "Device Name" "Service Provider Id" "Group Id" Device Type: "Device Type Name" Device Type Service Provider: "Service Provider Id" "Device Type Name" Service Provider: "Service Provider Id" Device Type Group: "Service Provider Id" "Group Id" "Device Type Name" Group: "Service Provider Id" "Group Id" User: "User Id" "Is Local" is set to "yes" if the event is processed on the server who received the request, "no" otherwise meaning that the event is processed on another server. "Completion %" provides an estimate of the completion of the event. A percentage is given, the current number of completed expanded event, and the total number of expanded event. "Pushed/ Same Hash/ Not Pushed" gives the total number of files that were pushed, not pushed because of same hash, and not pushed when processing the event. "LoginId" is the user or admin id who triggered the event. "Start Time" is the date when the event's processing started. The display shows the month, day, hours, minutes, and seconds (MM-dd hh:mm:ss). "Process Time" is the time taken to process the event in hours, minutes, seconds, and milliseconds (hhhh:mm:ss.SSS). "Rx Time" is the date when the event was received via OCI-P and stored in the system. The display shows the month, day, hours, minutes, and seconds (MM-dd hh:mm:ss). "Total Time" is the total time the event was in the system, from the moment it was received and stored until its processing ended, in hours, minutes, seconds, and milliseconds (hhhh:mm:ss.SSS). "Request" is the name of the OCI-P request that triggered the event. "Priority" is the priority of the event. "Tracking Id" is the tracking id of the OCI-P request that triggered the event. "End Time" is the difference, measured in milliseconds, between the event's end time and midnight, January 1, 1970 UTC

Attributes:

event_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupDeviceManagementEventGetListResponse22(OCIDataResponse):
    """Response to GroupDeviceManagementEventGetListRequest22.
        Contains a table with column headings: \"Event Id\", \"Status\", \"Action\",
        \"Level\", \"Type\", \"Additional Info\", \"Is Local\", \"Completion %\",
        \"Pushed/ Same Hash/ Not Pushed\", \"Login Id\", \"Start Time\",
        \"Process Time\", \"Rx Time\", \"Total Time\", \"Request\", \"Priority\",
        \"Tracking Id\", \"End Time\".
        \"Event Id\" is a unique identifier for the event.
        \"Status\" can be: Pending, Queued, In Progress,
        Process On Other Host, Stale, Completed, Canceled.
        \"Action\" can be: Delete, Download, Rebuild, Reset, Upload.
        \"Level\" can be: Device, Device Type, Device Type Group, Group, User.
        \"Type\" can be: Automatic, Manual.
        \"Additional Info\" includes the affected device type, device or group.
        It depends on the level of the event:
          Device Profile: \"Device Name\" \"Service Provider Id\" \"Group Id\"
          Device Type: \"Device Type Name\"
          Device Type Service Provider: \"Service Provider Id\" \"Device Type Name\"
          Service Provider: \"Service Provider Id\"
          Device Type Group: \"Service Provider Id\" \"Group Id\" \"Device Type Name\"
          Group: \"Service Provider Id\" \"Group Id\"
          User: \"User Id\"
        \"Is Local\" is set to \"yes\" if the event is processed on the server
        who received the request, \"no\" otherwise meaning that the event is
        processed on another server.
        \"Completion %\" provides an estimate of the completion of the event.
        A percentage is given, the current number of completed expanded event,
        and the total number of expanded event.
        \"Pushed/ Same Hash/ Not Pushed\" gives the total number of files that
        were pushed, not pushed because of same hash, and not pushed when
        processing the event.
        \"LoginId\" is the user or admin id who triggered the event.
        \"Start Time\" is the date when the event's processing started.  The
        display shows the month, day, hours, minutes, and seconds (MM-dd hh:mm:ss).
        \"Process Time\" is the time taken to process the event in hours,
        minutes, seconds, and milliseconds (hhhh:mm:ss.SSS).
        \"Rx Time\" is the date when the event was received via OCI-P and
        stored in the system.  The display shows the month, day, hours,
        minutes, and seconds (MM-dd hh:mm:ss).
        \"Total Time\" is the total time the event was in the system, from the
        moment it was received and stored until its processing ended, in
        hours, minutes, seconds, and milliseconds (hhhh:mm:ss.SSS).
        \"Request\" is the name of the OCI-P request that triggered the event.
        \"Priority\" is the priority of the event.
        \"Tracking Id\" is the tracking id of the OCI-P request that triggered the event.
        \"End Time\" is the difference, measured in milliseconds, between the
        event's end time and midnight, January 1, 1970 UTC

    Attributes:

        event_table (OCITable):

    """

    event_table: OCITable = field(metadata={"alias": "eventTable"})

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 GroupDeviceManagementEventGetListRequest22

client = Client()

command = GroupDeviceManagementEventGetListRequest22(
    service_provider_id=...,
    group_id=...,
    event_queue_type=...,
    response_size_limit=...,
    search_criteria_exact_device_management_event_status_in_progress_or_pending=...,
    search_criteria_exact_device_management_event_status_completed=...,
    search_criteria_exact_device_management_event_action=...,
    search_criteria_exact_device_management_event_level=...,
    search_criteria_exact_device_management_event_type=...,
    search_criteria_device_management_event_additional_info=...,
    search_criteria_device_management_event_login_id=...,
    search_criteria_device_management_event_request=...,
    search_criteria_device_management_event_request_tracking_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("GroupDeviceManagementEventGetListRequest22",
    service_provider_id=...,
    group_id=...,
    event_queue_type=...,
    response_size_limit=...,
    search_criteria_exact_device_management_event_status_in_progress_or_pending=...,
    search_criteria_exact_device_management_event_status_completed=...,
    search_criteria_exact_device_management_event_action=...,
    search_criteria_exact_device_management_event_level=...,
    search_criteria_exact_device_management_event_type=...,
    search_criteria_device_management_event_additional_info=...,
    search_criteria_device_management_event_login_id=...,
    search_criteria_device_management_event_request=...,
    search_criteria_device_management_event_request_tracking_id=...,
)

print(response)