Skip to content

GroupCPEConfigSetConfigFileRequest

Bases: OCIRequest

Request to set a new group default configuration file for a device type. The response is either a SuccessResponse or an ErrorResponse.

When the element configFile is set to nil, the configuration file defined
at the parent level is used.

Attributes:

service_provider_id (str):

group_id (str):

device_type (str):

config_file (Nillable[FileResource]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupCPEConfigSetConfigFileRequest(OCIRequest):
    """Request to set a new group default configuration file for a device type.
        The response is either a SuccessResponse or an ErrorResponse.

        When the element configFile is set to nil, the configuration file defined
        at the parent level is used.

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_type (str):

        config_file (Nillable[FileResource]):

    """

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

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

    device_type: str = field(metadata={"alias": "deviceType"})

    config_file: Nillable[FileResource] = field(metadata={"alias": "configFile"})

    def __post_init__(self):
        nillable_fields = ["config_file"]
        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_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupCPEConfigSetConfigFileRequest

client = Client()

command = GroupCPEConfigSetConfigFileRequest(
    service_provider_id=...,
    group_id=...,
    device_type=...,
    config_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCPEConfigSetConfigFileRequest",
    service_provider_id=...,
    group_id=...,
    device_type=...,
    config_file=...,
)

print(response)