📂 Advanced File Manager

Multi-Root Navigation System

⬆ Ke Atas 🏠 Root Server 🏠 Root App 🔄 Refresh

📍 Lokasi: /usr/lib/python3.9/site-packages/oci/opensearch/models 💾 Free: 47.4 GB

⚠️ Direktori ini tidak writable.

✏️ Mengedit: work_request.py

# coding: utf-8
# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.

# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20180828

from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
from oci.decorators import init_model_state_from_kwargs

@init_model_state_from_kwargs
class WorkRequest(object):
    """
    An asynchronous work request.
    """

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "CREATE_OPENSEARCH_CLUSTER"
    OPERATION_TYPE_CREATE_OPENSEARCH_CLUSTER = "CREATE_OPENSEARCH_CLUSTER"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "UPDATE_OPENSEARCH_CLUSTER"
    OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER = "UPDATE_OPENSEARCH_CLUSTER"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "DELETE_OPENSEARCH_CLUSTER"
    OPERATION_TYPE_DELETE_OPENSEARCH_CLUSTER = "DELETE_OPENSEARCH_CLUSTER"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "MOVE_OPENSEARCH_CLUSTER"
    OPERATION_TYPE_MOVE_OPENSEARCH_CLUSTER = "MOVE_OPENSEARCH_CLUSTER"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "RESTORE_OPENSEARCH_CLUSTER"
    OPERATION_TYPE_RESTORE_OPENSEARCH_CLUSTER = "RESTORE_OPENSEARCH_CLUSTER"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "BACKUP_OPENSEARCH_CLUSTER"
    OPERATION_TYPE_BACKUP_OPENSEARCH_CLUSTER = "BACKUP_OPENSEARCH_CLUSTER"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "UPDATE_OPENSEARCH_CLUSTER_BACKUP"
    OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER_BACKUP = "UPDATE_OPENSEARCH_CLUSTER_BACKUP"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "MOVE_OPENSEARCH_CLUSTER_BACKUP"
    OPERATION_TYPE_MOVE_OPENSEARCH_CLUSTER_BACKUP = "MOVE_OPENSEARCH_CLUSTER_BACKUP"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "DELETE_OPENSEARCH_CLUSTER_BACKUP"
    OPERATION_TYPE_DELETE_OPENSEARCH_CLUSTER_BACKUP = "DELETE_OPENSEARCH_CLUSTER_BACKUP"

#: A constant which can be used with the operation_type property of a WorkRequest.
    #: This constant has a value of "UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG"
    OPERATION_TYPE_UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG = "UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG"

#: A constant which can be used with the status property of a WorkRequest.
    #: This constant has a value of "ACCEPTED"
    STATUS_ACCEPTED = "ACCEPTED"

#: A constant which can be used with the status property of a WorkRequest.
    #: This constant has a value of "IN_PROGRESS"
    STATUS_IN_PROGRESS = "IN_PROGRESS"

#: A constant which can be used with the status property of a WorkRequest.
    #: This constant has a value of "FAILED"
    STATUS_FAILED = "FAILED"

#: A constant which can be used with the status property of a WorkRequest.
    #: This constant has a value of "SUCCEEDED"
    STATUS_SUCCEEDED = "SUCCEEDED"

#: A constant which can be used with the status property of a WorkRequest.
    #: This constant has a value of "CANCELING"
    STATUS_CANCELING = "CANCELING"

#: A constant which can be used with the status property of a WorkRequest.
    #: This constant has a value of "CANCELED"
    STATUS_CANCELED = "CANCELED"

def __init__(self, **kwargs):
        """
        Initializes a new WorkRequest object with values from keyword arguments.
        The following keyword arguments are supported (corresponding to the getters/setters of this class):

:param operation_type:
            The value to assign to the operation_type property of this WorkRequest.
            Allowed values for this property are: "CREATE_OPENSEARCH_CLUSTER", "UPDATE_OPENSEARCH_CLUSTER", "DELETE_OPENSEARCH_CLUSTER", "MOVE_OPENSEARCH_CLUSTER", "RESTORE_OPENSEARCH_CLUSTER", "BACKUP_OPENSEARCH_CLUSTER", "UPDATE_OPENSEARCH_CLUSTER_BACKUP", "MOVE_OPENSEARCH_CLUSTER_BACKUP", "DELETE_OPENSEARCH_CLUSTER_BACKUP", "UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type operation_type: str

:param status:
            The value to assign to the status property of this WorkRequest.
            Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type status: str

:param id:
            The value to assign to the id property of this WorkRequest.
        :type id: str

:param compartment_id:
            The value to assign to the compartment_id property of this WorkRequest.
        :type compartment_id: str

:param resources:
            The value to assign to the resources property of this WorkRequest.
        :type resources: list[oci.opensearch.models.WorkRequestResource]

:param percent_complete:
            The value to assign to the percent_complete property of this WorkRequest.
        :type percent_complete: float

:param time_accepted:
            The value to assign to the time_accepted property of this WorkRequest.
        :type time_accepted: datetime

:param time_started:
            The value to assign to the time_started property of this WorkRequest.
        :type time_started: datetime

:param time_finished:
            The value to assign to the time_finished property of this WorkRequest.
        :type time_finished: datetime

"""
        self.swagger_types = {
            'operation_type': 'str',
            'status': 'str',
            'id': 'str',
            'compartment_id': 'str',
            'resources': 'list[WorkRequestResource]',
            'percent_complete': 'float',
            'time_accepted': 'datetime',
            'time_started': 'datetime',
            'time_finished': 'datetime'
        }

self.attribute_map = {
            'operation_type': 'operationType',
            'status': 'status',
            'id': 'id',
            'compartment_id': 'compartmentId',
            'resources': 'resources',
            'percent_complete': 'percentComplete',
            'time_accepted': 'timeAccepted',
            'time_started': 'timeStarted',
            'time_finished': 'timeFinished'
        }

self._operation_type = None
        self._status = None
        self._id = None
        self._compartment_id = None
        self._resources = None
        self._percent_complete = None
        self._time_accepted = None
        self._time_started = None
        self._time_finished = None

@property
    def operation_type(self):
        """
        **[Required]** Gets the operation_type of this WorkRequest.
        The type of operation that spawned the work request.

Allowed values for this property are: "CREATE_OPENSEARCH_CLUSTER", "UPDATE_OPENSEARCH_CLUSTER", "DELETE_OPENSEARCH_CLUSTER", "MOVE_OPENSEARCH_CLUSTER", "RESTORE_OPENSEARCH_CLUSTER", "BACKUP_OPENSEARCH_CLUSTER", "UPDATE_OPENSEARCH_CLUSTER_BACKUP", "MOVE_OPENSEARCH_CLUSTER_BACKUP", "DELETE_OPENSEARCH_CLUSTER_BACKUP", "UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

:return: The operation_type of this WorkRequest.
        :rtype: str
        """
        return self._operation_type

@operation_type.setter
    def operation_type(self, operation_type):
        """
        Sets the operation_type of this WorkRequest.
        The type of operation that spawned the work request.

:param operation_type: The operation_type of this WorkRequest.
        :type: str
        """
        allowed_values = ["CREATE_OPENSEARCH_CLUSTER", "UPDATE_OPENSEARCH_CLUSTER", "DELETE_OPENSEARCH_CLUSTER", "MOVE_OPENSEARCH_CLUSTER", "RESTORE_OPENSEARCH_CLUSTER", "BACKUP_OPENSEARCH_CLUSTER", "UPDATE_OPENSEARCH_CLUSTER_BACKUP", "MOVE_OPENSEARCH_CLUSTER_BACKUP", "DELETE_OPENSEARCH_CLUSTER_BACKUP", "UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG"]
        if not value_allowed_none_or_none_sentinel(operation_type, allowed_values):
            operation_type = 'UNKNOWN_ENUM_VALUE'
        self._operation_type = operation_type

@property
    def status(self):
        """
        **[Required]** Gets the status of this WorkRequest.
        The status of current work request.

Allowed values for this property are: "ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

:return: The status of this WorkRequest.
        :rtype: str
        """
        return self._status

@status.setter
    def status(self, status):
        """
        Sets the status of this WorkRequest.
        The status of current work request.

:param status: The status of this WorkRequest.
        :type: str
        """
        allowed_values = ["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"]
        if not value_allowed_none_or_none_sentinel(status, allowed_values):
            status = 'UNKNOWN_ENUM_VALUE'
        self._status = status

@property
    def id(self):
        """
        **[Required]** Gets the id of this WorkRequest.
        The OCID of the work request.

:return: The id of this WorkRequest.
        :rtype: str
        """
        return self._id

@id.setter
    def id(self, id):
        """
        Sets the id of this WorkRequest.
        The OCID of the work request.

:param id: The id of this WorkRequest.
        :type: str
        """
        self._id = id

@property
    def compartment_id(self):
        """
        **[Required]** Gets the compartment_id of this WorkRequest.
        The OCID of the compartment that contains the work request.

:return: The compartment_id of this WorkRequest.
        :rtype: str
        """
        return self._compartment_id

@compartment_id.setter
    def compartment_id(self, compartment_id):
        """
        Sets the compartment_id of this WorkRequest.
        The OCID of the compartment that contains the work request.

:param compartment_id: The compartment_id of this WorkRequest.
        :type: str
        """
        self._compartment_id = compartment_id

@property
    def resources(self):
        """
        **[Required]** Gets the resources of this WorkRequest.
        The resources that are affected by the work request.

:return: The resources of this WorkRequest.
        :rtype: list[oci.opensearch.models.WorkRequestResource]
        """
        return self._resources

@resources.setter
    def resources(self, resources):
        """
        Sets the resources of this WorkRequest.
        The resources that are affected by the work request.

:param resources: The resources of this WorkRequest.
        :type: list[oci.opensearch.models.WorkRequestResource]
        """
        self._resources = resources

@property
    def percent_complete(self):
        """
        **[Required]** Gets the percent_complete of this WorkRequest.
        The percentage complete of the operation tracked by the work request.

:return: The percent_complete of this WorkRequest.
        :rtype: float
        """
        return self._percent_complete

@percent_complete.setter
    def percent_complete(self, percent_complete):
        """
        Sets the percent_complete of this WorkRequest.
        The percentage complete of the operation tracked by the work request.

:param percent_complete: The percent_complete of this WorkRequest.
        :type: float
        """
        self._percent_complete = percent_complete

@property
    def time_accepted(self):
        """
        **[Required]** Gets the time_accepted of this WorkRequest.
        The date and time the work request was created, in the format defined by `RFC 3339`__.