Skip to content

SystemIntegratedIMPModifyRequest

Bases: OCIRequest

Modify the system Integrated IMP service attributes. The response is either a SuccessResponse or an ErrorResponse.

The following elements are only used in AS data mode:
  boshURL
  allowImpPasswordRetrieval
  propagateImpErrorDetails

Attributes:

service_domain (Optional[Nillable[str]]):

service_port (Optional[Nillable[int]]):

add_service_provider_in_imp_user_id (Optional[bool]):

bosh_url (Optional[Nillable[str]]):

allow_imp_password_retrieval (Optional[bool]):

propagate_imp_error_details (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemIntegratedIMPModifyRequest(OCIRequest):
    """Modify the system Integrated IMP service attributes.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements are only used in AS data mode:
          boshURL
          allowImpPasswordRetrieval
          propagateImpErrorDetails

    Attributes:

        service_domain (Optional[Nillable[str]]):

        service_port (Optional[Nillable[int]]):

        add_service_provider_in_imp_user_id (Optional[bool]):

        bosh_url (Optional[Nillable[str]]):

        allow_imp_password_retrieval (Optional[bool]):

        propagate_imp_error_details (Optional[bool]):

    """

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

    service_port: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "servicePort"}
    )

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["service_domain", "service_port", "bosh_url"]
        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 SystemIntegratedIMPModifyRequest

client = Client()

command = SystemIntegratedIMPModifyRequest(
    service_domain=...,
    service_port=...,
    add_service_provider_in_imp_user_id=...,
    bosh_url=...,
    allow_imp_password_retrieval=...,
    propagate_imp_error_details=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemIntegratedIMPModifyRequest",
    service_domain=...,
    service_port=...,
    add_service_provider_in_imp_user_id=...,
    bosh_url=...,
    allow_imp_password_retrieval=...,
    propagate_imp_error_details=...,
)

print(response)