EnterpriseLocalGatewayGetPagedSortedListRequest

Bases: OCIRequest

Get a list of local gateways defined within an enterprise. Only the local gateways having device associated are returned.

If the responsePagingControl element is not provided, the paging startIndex will be set to 1
by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
If no sortOrder is included the response is sorted by Trunk group name  ascending by default.
Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
Then the search criteria are logically ORed together.

The response is either a EnterpriseLocalGatewayGetPagedSortedListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_by_trunk_group_name (Optional[SortByTrunkGroupName]):

search_criteria_trunk_group_name (Optional[List[SearchCriteriaTrunkGroupName]]):

search_criteria_mode_or (Optional[bool]):

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

@dataclass(kw_only=True)
class EnterpriseLocalGatewayGetPagedSortedListRequest(OCIRequest):
    """Get a list of local gateways defined within an enterprise. Only the local gateways having device associated are returned.

        If the responsePagingControl element is not provided, the paging startIndex will be set to 1
        by default, and the responsePageSize will be set to the maximum ResponsePageSize by default.
        If no sortOrder is included the response is sorted by Trunk group name  ascending by default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criteria are logically ORed together.

        The response is either a EnterpriseLocalGatewayGetPagedSortedListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_by_trunk_group_name (Optional[SortByTrunkGroupName]):

        search_criteria_trunk_group_name (Optional[List[SearchCriteriaTrunkGroupName]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_by_trunk_group_name: Optional[SortByTrunkGroupName] = field(
        default=None, metadata={"alias": "sortByTrunkGroupName"}
    )

    search_criteria_trunk_group_name: Optional[List[SearchCriteriaTrunkGroupName]] = (
        field(default=None, metadata={"alias": "searchCriteriaTrunkGroupName"})
    )

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

Responses

Bases: OCIDataResponse

Response to EnterpriseLocalGatewayGetPagedSortedListRequest. Contains a table with column headings "Name", "Device Name", "Device Level", "Group Id", "Group Name" and "Group External Id". The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. The following columns are only populated in AS data mode "Group External Id"

Attributes:

local_gateway_table (OCITable):

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

@dataclass(kw_only=True)
class EnterpriseLocalGatewayGetPagedSortedListResponse(OCIDataResponse):
    """Response to EnterpriseLocalGatewayGetPagedSortedListRequest.
        Contains a table with column headings \"Name\", \"Device Name\", \"Device Level\", \"Group Id\", \"Group Name\"  and \"Group External Id\".
        The \"Device Level\" column contains one of the AccessDeviceLevel enumerated constants.
        The following columns are only populated in AS data mode
        \"Group External Id\"

    Attributes:

        local_gateway_table (OCITable):

    """

    local_gateway_table: OCITable = field(metadata={"alias": "localGatewayTable"})

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 EnterpriseLocalGatewayGetPagedSortedListRequest

client = Client()

command = EnterpriseLocalGatewayGetPagedSortedListRequest(
    service_provider_id=...,
    response_paging_control=...,
    sort_by_trunk_group_name=...,
    search_criteria_trunk_group_name=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("EnterpriseLocalGatewayGetPagedSortedListRequest",
    service_provider_id=...,
    response_paging_control=...,
    sort_by_trunk_group_name=...,
    search_criteria_trunk_group_name=...,
    search_criteria_mode_or=...,
)

print(response)