Skip to content

GroupCollaborateBridgeModifyInstanceRequest20sp1

Bases: OCIRequest

Request to modify a Collaborate bridge. The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge. The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_user_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

maximum_bridge_participants (Optional[CollaborateBridgeMaximumParticipants]):

network_class_of_service (Optional[str]):

max_collaborate_room_participants (Optional[int]):

support_outdial (Optional[bool]):

collaborate_owner_user_id_list (Optional[Nillable[ReplacementUserIdList]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCollaborateBridgeModifyInstanceRequest20sp1(OCIRequest):
    """Request to modify a Collaborate bridge.
        The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge.
        The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        maximum_bridge_participants (Optional[CollaborateBridgeMaximumParticipants]):

        network_class_of_service (Optional[str]):

        max_collaborate_room_participants (Optional[int]):

        support_outdial (Optional[bool]):

        collaborate_owner_user_id_list (Optional[Nillable[ReplacementUserIdList]]):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    service_instance_profile: Optional[ServiceInstanceModifyProfile] = field(
        default=None, metadata={"alias": "serviceInstanceProfile"}
    )

    maximum_bridge_participants: Optional[CollaborateBridgeMaximumParticipants] = field(
        default=None, metadata={"alias": "maximumBridgeParticipants"}
    )

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

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

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

    collaborate_owner_user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "collaborateOwnerUserIdList"}
    )

    def __post_init__(self):
        nillable_fields = ["collaborate_owner_user_id_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 GroupCollaborateBridgeModifyInstanceRequest20sp1

client = Client()

command = GroupCollaborateBridgeModifyInstanceRequest20sp1(
    service_user_id=...,
    service_instance_profile=...,
    maximum_bridge_participants=...,
    network_class_of_service=...,
    max_collaborate_room_participants=...,
    support_outdial=...,
    collaborate_owner_user_id_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCollaborateBridgeModifyInstanceRequest20sp1",
    service_user_id=...,
    service_instance_profile=...,
    maximum_bridge_participants=...,
    network_class_of_service=...,
    max_collaborate_room_participants=...,
    support_outdial=...,
    collaborate_owner_user_id_list=...,
)

print(response)