SystemBroadWorksMobilityGeographicalPoolAddRequest

Bases: OCIRequest

Add a geographical pool to the system. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

name (str):

country_code (str):

is_default (bool):

description (Optional[str]):

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

@dataclass(kw_only=True)
class SystemBroadWorksMobilityGeographicalPoolAddRequest(OCIRequest):
    """Add a geographical pool to the system.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        name (str):

        country_code (str):

        is_default (bool):

        description (Optional[str]):

    """

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

    country_code: str = field(metadata={"alias": "countryCode"})

    is_default: bool = field(metadata={"alias": "isDefault"})

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

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 SystemBroadWorksMobilityGeographicalPoolAddRequest

client = Client()

command = SystemBroadWorksMobilityGeographicalPoolAddRequest(
    name=...,
    country_code=...,
    is_default=...,
    description=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemBroadWorksMobilityGeographicalPoolAddRequest",
    name=...,
    country_code=...,
    is_default=...,
    description=...,
)

print(response)