SystemMediaModifyRequest

Bases: OCIRequest

Request to modify a media. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

media_name (str):

codec_name (Optional[str]):

bandwidth_enforcement_type (Optional[str]):

media_bandwidth (Optional[Nillable[int]]):

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

@dataclass(kw_only=True)
class SystemMediaModifyRequest(OCIRequest):
    """Request to modify a media.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        media_name (str):

        codec_name (Optional[str]):

        bandwidth_enforcement_type (Optional[str]):

        media_bandwidth (Optional[Nillable[int]]):

    """

    media_name: str = field(metadata={"alias": "mediaName"})

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

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

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

    def __post_init__(self):
        nillable_fields = ["media_bandwidth"]
        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 SystemMediaModifyRequest

client = Client()

command = SystemMediaModifyRequest(
    media_name=...,
    codec_name=...,
    bandwidth_enforcement_type=...,
    media_bandwidth=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemMediaModifyRequest",
    media_name=...,
    codec_name=...,
    bandwidth_enforcement_type=...,
    media_bandwidth=...,
)

print(response)