Skip to content

EnterpriseVoiceVPNGetPolicyListRequest

Bases: OCIRequest

Request the list of Voice VPN locations. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either a EnterpriseVoiceVPNGetPolicyListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

search_criteria_group_location_code (Optional[List[SearchCriteriaGroupLocationCode]]):

search_criteria_exact_policy_selection (Optional[SearchCriteriaExactPolicySelection]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseVoiceVPNGetPolicyListRequest(OCIRequest):
    """Request the list of Voice VPN locations.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        The response is either a EnterpriseVoiceVPNGetPolicyListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        search_criteria_group_location_code (Optional[List[SearchCriteriaGroupLocationCode]]):

        search_criteria_exact_policy_selection (Optional[SearchCriteriaExactPolicySelection]):

    """

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

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

    search_criteria_group_location_code: Optional[
        List[SearchCriteriaGroupLocationCode]
    ] = field(default=None, metadata={"alias": "searchCriteriaGroupLocationCode"})

    search_criteria_exact_policy_selection: Optional[
        SearchCriteriaExactPolicySelection
    ] = field(default=None, metadata={"alias": "searchCriteriaExactPolicySelection"})

Responses

Bases: OCIDataResponse

Response to EnterpriseVoiceVPNGetListResponse. Returns a 4 column table with column headings: "Location Code", "Min Extension Length", "Max Extension Length", "Location Selection".

Attributes:

location_list (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseVoiceVPNGetPolicyListResponse(OCIDataResponse):
    """Response to EnterpriseVoiceVPNGetListResponse.
        Returns a 4 column table with column headings:
          \"Location Code\", \"Min Extension Length\", \"Max Extension Length\", \"Location Selection\".

    Attributes:

        location_list (OCITable):

    """

    location_list: OCITable = field(metadata={"alias": "locationList"})

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 EnterpriseVoiceVPNGetPolicyListRequest

client = Client()

command = EnterpriseVoiceVPNGetPolicyListRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_group_location_code=...,
    search_criteria_exact_policy_selection=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("EnterpriseVoiceVPNGetPolicyListRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_group_location_code=...,
    search_criteria_exact_policy_selection=...,
)

print(response)