GroupUserLanguageModifyRequest

Bases: OCIRequest

Request to modify language of the users within a group. If neither applyToUsers nor applyToServiceInstances is specified in the request, language is not changed for any user in the group. If applyToUsers is specified, regular users within the group have the language modified. If applyToServiceInstances is specified, the service instance users within the group have the language modified.

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

language (str):

apply_to_users (Optional[bool]):

apply_to_service_instances (Optional[bool]):

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

@dataclass(kw_only=True)
class GroupUserLanguageModifyRequest(OCIRequest):
    """Request to modify language of the users within a group.
        If neither applyToUsers nor applyToServiceInstances is specified in the request, language is not changed for any user in the group.
        If applyToUsers is specified, regular users within the group have the language modified.
        If applyToServiceInstances is specified, the service instance users within the group have the language modified.

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        language (str):

        apply_to_users (Optional[bool]):

        apply_to_service_instances (Optional[bool]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    language: str = field(metadata={"alias": "language"})

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

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

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 GroupUserLanguageModifyRequest

client = Client()

command = GroupUserLanguageModifyRequest(
    service_provider_id=...,
    group_id=...,
    language=...,
    apply_to_users=...,
    apply_to_service_instances=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupUserLanguageModifyRequest",
    service_provider_id=...,
    group_id=...,
    language=...,
    apply_to_users=...,
    apply_to_service_instances=...,
)

print(response)