SystemOfficeZoneGetRequest

Bases: OCIRequest

Get an existing Office Zone. The response is either a SystemOfficeZoneGetResponse or an ErrorResponse.

Attributes:

office_zone_name (str):

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

@dataclass(kw_only=True)
class SystemOfficeZoneGetRequest(OCIRequest):
    """Get an existing Office Zone.
        The response is either a SystemOfficeZoneGetResponse
        or an ErrorResponse.

    Attributes:

        office_zone_name (str):

    """

    office_zone_name: str = field(metadata={"alias": "officeZoneName"})

Responses

Bases: OCIDataResponse

Response to the SystemOfficeZoneGetRequest. The response contains the Office Zone information.

Attributes:

description (Optional[str]):

zone_name (List[str]):

primary_zone_name (str):

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

@dataclass(kw_only=True)
class SystemOfficeZoneGetResponse(OCIDataResponse):
    """Response to the SystemOfficeZoneGetRequest.
        The response contains the Office Zone information.

    Attributes:

        description (Optional[str]):

        zone_name (List[str]):

        primary_zone_name (str):

    """

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

    zone_name: List[str] = field(metadata={"alias": "zoneName"})

    primary_zone_name: str = field(metadata={"alias": "primaryZoneName"})

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 SystemOfficeZoneGetRequest

client = Client()

command = SystemOfficeZoneGetRequest(
    office_zone_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemOfficeZoneGetRequest",
    office_zone_name=...,
)

print(response)