Skip to content

UserAccessDeviceTagsGetRequest

Bases: OCIRequest

Request to get all the device tag names and values for a specific device. The resolved tags are returned only if the device is the main device for this user. The response is either a UserAccessDeviceTagsGetResponse or an ErrorResponse.

Attributes:

user_id (str):

access_device (AccessDevice):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserAccessDeviceTagsGetRequest(OCIRequest):
    """Request to get all the device tag names and values for a specific device. The resolved tags are returned only if the device is the main device for this user.
        The response is either a UserAccessDeviceTagsGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        access_device (AccessDevice):

    """

    user_id: str = field(metadata={"alias": "userId"})

    access_device: AccessDevice = field(metadata={"alias": "accessDevice"})

Responses

Bases: OCIDataResponse

Response to UserAccessDeviceTagsGetRequest. The response contains a table with columns: "Tag Name", and "Tag Value".

Attributes:

device_tags_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserAccessDeviceTagsGetResponse(OCIDataResponse):
    """Response to UserAccessDeviceTagsGetRequest.
        The response contains a table with columns: \"Tag Name\", and \"Tag Value\".

    Attributes:

        device_tags_table (OCITable):

    """

    device_tags_table: OCITable = field(metadata={"alias": "deviceTagsTable"})

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 UserAccessDeviceTagsGetRequest

client = Client()

command = UserAccessDeviceTagsGetRequest(
    user_id=...,
    access_device=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserAccessDeviceTagsGetRequest",
    user_id=...,
    access_device=...,
)

print(response)