Skip to content

ServiceProviderServicePackMigrationTaskModifyRequest

Bases: OCIRequest

Modify the properties of a specified service pack migration task. Modification is only allowed prior to task execution. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

task_name (str):

new_task_name (Optional[str]):

start_timestamp (Optional[str]):

expire_after_num_hours (Optional[int]):

max_duration_hours (Optional[int]):

send_report_email (Optional[bool]):

report_delivery_email_address (Optional[Nillable[str]]):

abort_on_error (Optional[bool]):

abort_error_threshold (Optional[Nillable[int]]):

report_all_users (Optional[bool]):

automatically_increment_service_quantity (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderServicePackMigrationTaskModifyRequest(OCIRequest):
    """Modify the properties of a specified service pack migration task.
        Modification is only allowed prior to task execution.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        task_name (str):

        new_task_name (Optional[str]):

        start_timestamp (Optional[str]):

        expire_after_num_hours (Optional[int]):

        max_duration_hours (Optional[int]):

        send_report_email (Optional[bool]):

        report_delivery_email_address (Optional[Nillable[str]]):

        abort_on_error (Optional[bool]):

        abort_error_threshold (Optional[Nillable[int]]):

        report_all_users (Optional[bool]):

        automatically_increment_service_quantity (Optional[bool]):

    """

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

    task_name: str = field(metadata={"alias": "taskName"})

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

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

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

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["report_delivery_email_address", "abort_error_threshold"]
        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_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 ServiceProviderServicePackMigrationTaskModifyRequest

client = Client()

command = ServiceProviderServicePackMigrationTaskModifyRequest(
    service_provider_id=...,
    task_name=...,
    new_task_name=...,
    start_timestamp=...,
    expire_after_num_hours=...,
    max_duration_hours=...,
    send_report_email=...,
    report_delivery_email_address=...,
    abort_on_error=...,
    abort_error_threshold=...,
    report_all_users=...,
    automatically_increment_service_quantity=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("ServiceProviderServicePackMigrationTaskModifyRequest",
    service_provider_id=...,
    task_name=...,
    new_task_name=...,
    start_timestamp=...,
    expire_after_num_hours=...,
    max_duration_hours=...,
    send_report_email=...,
    report_delivery_email_address=...,
    abort_on_error=...,
    abort_error_threshold=...,
    report_all_users=...,
    automatically_increment_service_quantity=...,
)

print(response)