ServiceProviderBroadWorksCommunicatorGetRequest

Bases: OCIRequest

Request to get Configuration Server for a specified service provider. The response is either a ServiceProviderBroadWorksCommunicatorGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

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

@dataclass(kw_only=True)
class ServiceProviderBroadWorksCommunicatorGetRequest(OCIRequest):
    """Request to get Configuration Server for a specified service
        provider. The response is either a ServiceProviderBroadWorksCommunicatorGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

Responses

Bases: OCIDataResponse

Response to ServiceProviderBroadWorksCommunicatorGetRequest.

Attributes:

configuration_server_url (Optional[str]):

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

@dataclass(kw_only=True)
class ServiceProviderBroadWorksCommunicatorGetResponse(OCIDataResponse):
    """Response to ServiceProviderBroadWorksCommunicatorGetRequest.

    Attributes:

        configuration_server_url (Optional[str]):

    """

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

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 ServiceProviderBroadWorksCommunicatorGetRequest

client = Client()

command = ServiceProviderBroadWorksCommunicatorGetRequest(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("ServiceProviderBroadWorksCommunicatorGetRequest",
    service_provider_id=...,
)

print(response)