UserAccessDeviceFileGetRequest

Bases: OCIRequest

Request to get a user modifiable file. The response is either UserAccessDeviceFileGetResponse or ErrorResponse.

Attributes:

user_id (str):

access_device (AccessDevice):

file_format (str):

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

@dataclass(kw_only=True)
class UserAccessDeviceFileGetRequest(OCIRequest):
    """Request to get a user modifiable file.
        The response is either UserAccessDeviceFileGetResponse or ErrorResponse.

    Attributes:

        user_id (str):

        access_device (AccessDevice):

        file_format (str):

    """

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

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

    file_format: str = field(metadata={"alias": "fileFormat"})

Responses

Bases: OCIDataResponse

Response to UserAccessDeviceFileGetRequest.

Attributes:

template_url (Optional[str]):

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

@dataclass(kw_only=True)
class UserAccessDeviceFileGetResponse(OCIDataResponse):
    """Response to UserAccessDeviceFileGetRequest.

    Attributes:

        template_url (Optional[str]):

    """

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

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 UserAccessDeviceFileGetRequest

client = Client()

command = UserAccessDeviceFileGetRequest(
    user_id=...,
    access_device=...,
    file_format=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserAccessDeviceFileGetRequest",
    user_id=...,
    access_device=...,
    file_format=...,
)

print(response)