Skip to content

SystemShInterfaceRefreshTaskGetRequest

Bases: OCIRequest

Retrieves the status of the system refresh task on the local Application Server node. The response is either a SystemShInterfaceRefreshTaskGetResponse or an ErrorResponse.

Attributes:

Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemShInterfaceRefreshTaskGetRequest(OCIRequest):
    """Retrieves the status of the system refresh task on the local Application Server node.
        The response is either a SystemShInterfaceRefreshTaskGetResponse or an ErrorResponse.

    Attributes:

    """

Responses

Bases: OCIDataResponse

Response to SystemShInterfaceRefreshTaskGetRequest. Provides the status of the system refresh task. If isRunning is false, numberPublicIdentityRefreshStarted and numberPublicIdentities are omitted. If isRunning is true, numberPublicIdentities indicates the total number of public identities in the system that will be refreshed by the system refresh task; numberPublicIdentityRefreshesStarted indicates the total number of public identities for which a refresh has been started.

Attributes:

is_running (bool):

number_public_identity_refreshes_started (Optional[int]):

number_public_identities (Optional[int]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemShInterfaceRefreshTaskGetResponse(OCIDataResponse):
    """Response to SystemShInterfaceRefreshTaskGetRequest.  Provides the status of the system refresh task.  If isRunning is false, numberPublicIdentityRefreshStarted and numberPublicIdentities are omitted.  If isRunning is true, numberPublicIdentities indicates the total number of public identities in the system that will be refreshed by the system refresh task; numberPublicIdentityRefreshesStarted indicates the total number of public identities for which a refresh has been started.

    Attributes:

        is_running (bool):

        number_public_identity_refreshes_started (Optional[int]):

        number_public_identities (Optional[int]):

    """

    is_running: bool = field(metadata={"alias": "isRunning"})

    number_public_identity_refreshes_started: Optional[int] = field(
        default=None, metadata={"alias": "numberPublicIdentityRefreshesStarted"}
    )

    number_public_identities: Optional[int] = field(
        default=None, metadata={"alias": "numberPublicIdentities"}
    )

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 SystemShInterfaceRefreshTaskGetRequest

client = Client()

command = SystemShInterfaceRefreshTaskGetRequest()

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemShInterfaceRefreshTaskGetRequest")

print(response)