SystemOfficeZoneModifyRequest

Bases: OCIRequest

Modify an existing Office Zone. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

office_zone_name (str):

new_office_zone_name (Optional[str]):

description (Optional[Nillable[str]]):

replacement_zone_list (Optional[ReplacementZoneList]):

primary_zone_name (Optional[str]):

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

@dataclass(kw_only=True)
class SystemOfficeZoneModifyRequest(OCIRequest):
    """Modify an existing Office Zone.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        office_zone_name (str):

        new_office_zone_name (Optional[str]):

        description (Optional[Nillable[str]]):

        replacement_zone_list (Optional[ReplacementZoneList]):

        primary_zone_name (Optional[str]):

    """

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

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

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

    replacement_zone_list: Optional[ReplacementZoneList] = field(
        default=None, metadata={"alias": "replacementZoneList"}
    )

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

    def __post_init__(self):
        nillable_fields = ["description"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

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 SystemOfficeZoneModifyRequest

client = Client()

command = SystemOfficeZoneModifyRequest(
    office_zone_name=...,
    new_office_zone_name=...,
    description=...,
    replacement_zone_list=...,
    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("SystemOfficeZoneModifyRequest",
    office_zone_name=...,
    new_office_zone_name=...,
    description=...,
    replacement_zone_list=...,
    primary_zone_name=...,
)

print(response)