SystemBroadWorksMobilityGeographicalPoolModifyRequest

Bases: OCIRequest

Modify the settings of a geographical pool. The response is either SuccessResponse or ErrorResponse.

Attributes:

name (str):

new_name (Optional[str]):

is_default (Optional[bool]):

description (Optional[Nillable[str]]):

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

@dataclass(kw_only=True)
class SystemBroadWorksMobilityGeographicalPoolModifyRequest(OCIRequest):
    """Modify the settings of a geographical pool.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        name (str):

        new_name (Optional[str]):

        is_default (Optional[bool]):

        description (Optional[Nillable[str]]):

    """

    name: str = field(metadata={"alias": "name"})

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

    is_default: Optional[bool] = field(default=None, metadata={"alias": "isDefault"})

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

    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_fast/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

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 SystemBroadWorksMobilityGeographicalPoolModifyRequest

client = Client()

command = SystemBroadWorksMobilityGeographicalPoolModifyRequest(
    name=...,
    new_name=...,
    is_default=...,
    description=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemBroadWorksMobilityGeographicalPoolModifyRequest",
    name=...,
    new_name=...,
    is_default=...,
    description=...,
)

print(response)