UserDirectRouteModifyRequest

Bases: OCIRequest

Modify the direct route setting and the list of DTGs/Trunk Identities assigned to a user. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

outgoing_dtg_policy (Optional[str]):

outgoing_trunk_identity_policy (Optional[str]):

direct_route_identity_list (Optional[Nillable[DirectRouteReplacementIdentityList]]):

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

@dataclass(kw_only=True)
class UserDirectRouteModifyRequest(OCIRequest):
    """Modify the direct route setting and the list of DTGs/Trunk Identities assigned to a user.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        outgoing_dtg_policy (Optional[str]):

        outgoing_trunk_identity_policy (Optional[str]):

        direct_route_identity_list (Optional[Nillable[DirectRouteReplacementIdentityList]]):

    """

    user_id: str = field(metadata={"alias": "userId"})

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

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

    direct_route_identity_list: Optional[
        Nillable[DirectRouteReplacementIdentityList]
    ] = field(default=None, metadata={"alias": "directRouteIdentityList"})

    def __post_init__(self):
        nillable_fields = ["direct_route_identity_list"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 UserDirectRouteModifyRequest

client = Client()

command = UserDirectRouteModifyRequest(
    user_id=...,
    outgoing_dtg_policy=...,
    outgoing_trunk_identity_policy=...,
    direct_route_identity_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserDirectRouteModifyRequest",
    user_id=...,
    outgoing_dtg_policy=...,
    outgoing_trunk_identity_policy=...,
    direct_route_identity_list=...,
)

print(response)