GroupAccessDeviceCustomTagAddRequest

Bases: OCIRequest

Request to add a static configuration tag for a group access device. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

device_name (str):

tag_name (str):

tag_value (Optional[str]):

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

@dataclass(kw_only=True)
class GroupAccessDeviceCustomTagAddRequest(OCIRequest):
    """Request to add a static configuration tag for a group access device.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        device_name (str):

        tag_name (str):

        tag_value (Optional[str]):

    """

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

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

    device_name: str = field(metadata={"alias": "deviceName"})

    tag_name: str = field(metadata={"alias": "tagName"})

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

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 GroupAccessDeviceCustomTagAddRequest

client = Client()

command = GroupAccessDeviceCustomTagAddRequest(
    service_provider_id=...,
    group_id=...,
    device_name=...,
    tag_name=...,
    tag_value=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceCustomTagAddRequest",
    service_provider_id=...,
    group_id=...,
    device_name=...,
    tag_name=...,
    tag_value=...,
)

print(response)