EnterpriseLocalGatewayGetUsageRequest

Bases: OCIRequest

Get usage details of a local gateway under an enterprise. The response is either EnterpriseLocalGatewayGetUsageResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

trunk_group_name (str):

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

@dataclass(kw_only=True)
class EnterpriseLocalGatewayGetUsageRequest(OCIRequest):
    """Get usage details of a local gateway under an enterprise.
        The response is either EnterpriseLocalGatewayGetUsageResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        trunk_group_name (str):

    """

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

    trunk_group_name: str = field(metadata={"alias": "trunkGroupName"})

Responses

Bases: OCIDataResponse

Response to EnterpriseLocalGatewayGetUsageRequest. Returns the group ID and group name where the local gateway belongs to, a boolean value to indicate if the local gateway is used in the enterprise call processing policy. It also returns an OCITable containing the groups using the given local gateway. Column headings are: "Group Id", "Group Name" and "Group External Id". The following columns are only populated in AS data mode "Group External Id"

Attributes:

gateway_group_id (str):

gateway_group_name (Optional[str]):

used_by_enterprise (bool):

group_table (OCITable):

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

@dataclass(kw_only=True)
class EnterpriseLocalGatewayGetUsageResponse(OCIDataResponse):
    """Response to EnterpriseLocalGatewayGetUsageRequest.
        Returns the group ID and group name where the local gateway belongs to, a boolean value to indicate if the local gateway is
        used in the enterprise call processing policy.
        It also returns an OCITable containing the groups using the given local gateway.
        Column headings are: \"Group Id\", \"Group Name\" and \"Group External Id\".
        The following columns are only populated in AS data mode
        \"Group External Id\"

    Attributes:

        gateway_group_id (str):

        gateway_group_name (Optional[str]):

        used_by_enterprise (bool):

        group_table (OCITable):

    """

    gateway_group_id: str = field(metadata={"alias": "gatewayGroupId"})

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

    used_by_enterprise: bool = field(metadata={"alias": "usedByEnterprise"})

    group_table: OCITable = field(metadata={"alias": "groupTable"})

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 EnterpriseLocalGatewayGetUsageRequest

client = Client()

command = EnterpriseLocalGatewayGetUsageRequest(
    service_provider_id=...,
    trunk_group_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseLocalGatewayGetUsageRequest",
    service_provider_id=...,
    trunk_group_name=...,
)

print(response)