SystemOfficeZoneAddRequest

Bases: OCIRequest

Add a new Office Zone. The zoneList is an ordered list with the first member being of the highest priority. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

office_zone_name (str):

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 SystemOfficeZoneAddRequest(OCIRequest):
    """Add a new Office Zone.  The zoneList is an ordered list with the first member being of the highest priority.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        office_zone_name (str):

        description (Optional[str]):

        zone_name (List[str]):

        primary_zone_name (str):

    """

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

    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"})

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 SystemOfficeZoneAddRequest

client = Client()

command = SystemOfficeZoneAddRequest(
    office_zone_name=...,
    description=...,
    zone_name=...,
    primary_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("SystemOfficeZoneAddRequest",
    office_zone_name=...,
    description=...,
    zone_name=...,
    primary_zone_name=...,
)

print(response)