UserGroupNightForwardingModifyRequest

Bases: OCIRequest

Request to modify the Group Night Forwarding user parameters. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

night_forwarding (Optional[str]):

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

@dataclass(kw_only=True)
class UserGroupNightForwardingModifyRequest(OCIRequest):
    """Request to modify the Group Night Forwarding user parameters.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        night_forwarding (Optional[str]):

    """

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

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

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 UserGroupNightForwardingModifyRequest

client = Client()

command = UserGroupNightForwardingModifyRequest(
    user_id=...,
    night_forwarding=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGroupNightForwardingModifyRequest",
    user_id=...,
    night_forwarding=...,
)

print(response)