SystemMediaServerModifyRequest

Bases: OCIRequest

Request to modify a Media Server in the system. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

net_address (str):

port (Optional[Nillable[int]]):

transport_protocol (Optional[str]):

description (Optional[Nillable[str]]):

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

@dataclass(kw_only=True)
class SystemMediaServerModifyRequest(OCIRequest):
    """Request to modify a Media Server in the system.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        net_address (str):

        port (Optional[Nillable[int]]):

        transport_protocol (Optional[str]):

        description (Optional[Nillable[str]]):

    """

    net_address: str = field(metadata={"alias": "netAddress"})

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

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

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

    def __post_init__(self):
        nillable_fields = ["port", "description"]
        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 SystemMediaServerModifyRequest

client = Client()

command = SystemMediaServerModifyRequest(
    net_address=...,
    port=...,
    transport_protocol=...,
    description=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemMediaServerModifyRequest",
    net_address=...,
    port=...,
    transport_protocol=...,
    description=...,
)

print(response)