SystemBroadCloudModifyRequest

Bases: OCIRequest

Modify the system interface attributes for Messaging Server/BroadCloud. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

provisioning_url (Optional[Nillable[str]]):

provisioning_user_id (Optional[Nillable[str]]):

provisioning_password (Optional[Nillable[str]]):

enable_synchronization (Optional[bool]):

proxy_host (Optional[Nillable[str]]):

proxy_port (Optional[int]):

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

@dataclass(kw_only=True)
class SystemBroadCloudModifyRequest(OCIRequest):
    """Modify the system interface attributes for Messaging Server/BroadCloud.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        provisioning_url (Optional[Nillable[str]]):

        provisioning_user_id (Optional[Nillable[str]]):

        provisioning_password (Optional[Nillable[str]]):

        enable_synchronization (Optional[bool]):

        proxy_host (Optional[Nillable[str]]):

        proxy_port (Optional[int]):

    """

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

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

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

    enable_synchronization: Optional[bool] = field(
        default=None, metadata={"alias": "enableSynchronization"}
    )

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

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

    def __post_init__(self):
        nillable_fields = [
            "provisioning_url",
            "provisioning_user_id",
            "provisioning_password",
            "proxy_host",
        ]
        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 SystemBroadCloudModifyRequest

client = Client()

command = SystemBroadCloudModifyRequest(
    provisioning_url=...,
    provisioning_user_id=...,
    provisioning_password=...,
    enable_synchronization=...,
    proxy_host=...,
    proxy_port=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemBroadCloudModifyRequest",
    provisioning_url=...,
    provisioning_user_id=...,
    provisioning_password=...,
    enable_synchronization=...,
    proxy_host=...,
    proxy_port=...,
)

print(response)