GroupScheduleUsageRequest

Bases: OCIRequest

Get the list of services using a group schedule. The response is either a GroupScheduleUsageResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

schedule_key (ScheduleKey):

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

@dataclass(kw_only=True)
class GroupScheduleUsageRequest(OCIRequest):
    """Get the list of services using a group schedule.
        The response is either a GroupScheduleUsageResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        schedule_key (ScheduleKey):

    """

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

    group_id: str = field(metadata={"alias": "groupId"})

    schedule_key: ScheduleKey = field(metadata={"alias": "scheduleKey"})

Responses

Bases: OCIDataResponse

Response to GroupScheduleUsageRequest. The response contains a list of service names. The response contains the usage for the requested schedule. The usage table has columns "Service Name", and "Instance Name". The Service Name values correspond to string values of the GroupService and UserService data types.

Attributes:

usage_table (OCITable):

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

@dataclass(kw_only=True)
class GroupScheduleUsageResponse(OCIDataResponse):
    """Response to GroupScheduleUsageRequest.
        The response contains a list of service names.
        The response contains the usage for the requested schedule.
        The usage table has columns \"Service Name\", and \"Instance Name\".
        The Service Name values correspond to string values of the GroupService and UserService data types.

    Attributes:

        usage_table (OCITable):

    """

    usage_table: OCITable = field(metadata={"alias": "usageTable"})

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 GroupScheduleUsageRequest

client = Client()

command = GroupScheduleUsageRequest(
    service_provider_id=...,
    group_id=...,
    schedule_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupScheduleUsageRequest",
    service_provider_id=...,
    group_id=...,
    schedule_key=...,
)

print(response)