GroupInventoryReportGetRequest

Bases: OCIRequest

Request the group's inventory report. The response is either a GroupInventoryReportGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

include_users (bool):

include_services (bool):

include_dns (bool):

include_access_devices (bool):

include_departments (bool):

report_delivery_email_address (Optional[str]):

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

@dataclass(kw_only=True)
class GroupInventoryReportGetRequest(OCIRequest):
    """Request the group's inventory report.
        The response is either a GroupInventoryReportGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        include_users (bool):

        include_services (bool):

        include_dns (bool):

        include_access_devices (bool):

        include_departments (bool):

        report_delivery_email_address (Optional[str]):

    """

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

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

    include_users: bool = field(metadata={"alias": "includeUsers"})

    include_services: bool = field(metadata={"alias": "includeServices"})

    include_dns: bool = field(metadata={"alias": "includeDns"})

    include_access_devices: bool = field(metadata={"alias": "includeAccessDevices"})

    include_departments: bool = field(metadata={"alias": "includeDepartments"})

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

Responses

Bases: OCIDataResponse

Response to GroupInventoryReportGetRequest.

Attributes:

inventory_report_table (OCITable):

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

@dataclass(kw_only=True)
class GroupInventoryReportGetResponse(OCIDataResponse):
    """Response to GroupInventoryReportGetRequest.

    Attributes:

        inventory_report_table (OCITable):

    """

    inventory_report_table: OCITable = field(metadata={"alias": "inventoryReportTable"})

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 GroupInventoryReportGetRequest

client = Client()

command = GroupInventoryReportGetRequest(
    service_provider_id=...,
    group_id=...,
    include_users=...,
    include_services=...,
    include_dns=...,
    include_access_devices=...,
    include_departments=...,
    report_delivery_email_address=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupInventoryReportGetRequest",
    service_provider_id=...,
    group_id=...,
    include_users=...,
    include_services=...,
    include_dns=...,
    include_access_devices=...,
    include_departments=...,
    report_delivery_email_address=...,
)

print(response)