a Ofu@sddlmZddlmZddlmZddlmZmZddlm Z ddl m Z m Z ddl mZddlmZmZmZd d lmZed ZGd d d eZdS))absolute_import)requests)six)retrycircuit_breaker) BaseClient)get_config_value_or_defaultvalidate_config)Signer)Sentinel#get_signer_from_authentication_typeAUTHENTICATION_TYPE_FIELD_NAME)work_requests_type_mappingMissingc@s8eZdZdZddZddZddZdd Zd d Zd S) WorkRequestClienta Many of the API operations that you use to create and configure Compute resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running workflows. For more information about work requests and the operations that spawn work requests, see [Viewing the State of a Compute Work Request](/iaas/Content/Compute/Tasks/viewingworkrequestcompute.htm). c Ks t||ddd|vr$|d}nDt|vr6t|}n2t|d|d|d|dt|d|dd }d |d d d |dd|dtjd}d|vr|d|d<|ddurtj|d<d|vr|d|d<t d||t fi||_ |d|_ |d|_ dS)a Creates a new service client :param dict config: Configuration keys and values as per `SDK and Tool Configuration `__. The :py:meth:`~oci.config.from_file` method can be used to load configuration from a file. Alternatively, a ``dict`` can be passed. You can validate_config the dict using :py:meth:`~oci.config.validate_config` :param str service_endpoint: (optional) The endpoint of the service to call using this client. For example ``https://iaas.us-ashburn-1.oraclecloud.com``. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint. :param timeout: (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout. :type timeout: float or tuple(float, float) :param signer: (optional) The signer to use when signing requests made by the service client. The default is to use a :py:class:`~oci.signer.Signer` based on the values provided in the config parameter. One use case for this parameter is for `Instance Principals authentication `__ by passing an instance of :py:class:`~oci.auth.signers.InstancePrincipalsSecurityTokenSigner` as the value for this keyword argument :type signer: :py:class:`~oci.signer.AbstractBaseSigner` :param obj retry_strategy: (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a ``retry_strategy`` keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. A convenience :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` is also available. The specifics of the default retry strategy are described `here `__. :param obj circuit_breaker_strategy: (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses :py:data:`~oci.circuit_breaker.DEFAULT_CIRCUIT_BREAKER_STRATEGY` as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described `here `__. :param function circuit_breaker_callback: (optional) Callback function to receive any exceptions triggerred by the circuit breaker. :param allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object. signer)rtenancyuser fingerprintkey_file pass_phrase key_content)rrrprivate_key_file_locationrprivate_key_contentTservice_endpointz /20160918z)https://iaas.{region}.{secondLevelDomain}skip_deserializationFcircuit_breaker_strategy)regional_clientr base_pathservice_endpoint_templaterrtimeoutNallow_control_chars work_requestretry_strategycircuit_breaker_callback)r getr r r rrGLOBAL_CIRCUIT_BREAKER_STRATEGY DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientr$r%)selfconfigkwargsrbase_client_init_kwargsr./sparta/input/_build_configuration/image_build+validate/lib/bmcenv/lib64/python3.9/site-packages/oci/work_requests/work_request_client.py__init__s:0       zWorkRequestClient.__init__c s\d}d}d}d}gdfddt|D}|rBtd|d |i}d d t|D}t|D]:\} } | d ust| tjrht| d krhtd| qhdd| dt d} dd t| D} |j j | d|j d} | r6t| tjs|j | | |j| j|j j|||| d| d||d S|j j|||| d| d||dSd S)a; Gets the details of a work request. :param str work_request_id: (required) The `OCID`__ of the work request. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type :class:`~oci.work_requests.models.WorkRequest` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_work_request API. z/workRequests/{workRequestId}GETget_work_requestzVhttps://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest)r"r$opc_request_idcsg|]}|vr|qSr.r..0_keyexpected_kwargsr.r/ z6WorkRequestClient.get_work_request..z)get_work_request got unknown kwargs: {!r} workRequestIdcSsi|]\}}|tur||qSr.missingr5kvr.r.r/ r:z6WorkRequestClient.get_work_request..Nr7Parameter {} cannot be None, whitespace or empty stringapplication/jsonr3acceptz content-typezopc-request-idcSs&i|]\}}|tur|dur||qSNr<r>r.r.r/rAr:r$operation_retry_strategyclient_retry_strategy WorkRequestr") resource_pathmethod path_params header_params response_typer"operation_nameapi_reference_linkriterkeys ValueErrorformat iteritems isinstance string_typeslenstripr&r=r)get_preferred_retry_strategyr$rNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackr%make_retrying_callcall_api) r*work_request_idr,rKrLrPrQ extra_kwargsrMr?r@rNr$r.r7r/r2psd $    z"WorkRequestClient.get_work_requestc sd}d}d}d}gdfddt|D}|rBtd|d |i}d d t|D}t|D]:\} } | d ust| tjrht| d krhtd| qhd|vrddg} |d| vrtd| | dt | dt | dt d} dd t| D} dd| dt d} dd t| D} |j j | d|j d}|rt|tjsr|j | ||j|j|j j|||| | d| d||d S|j j|||| | d| d||d Sd S) a Gets the errors for a work request. :param str work_request_id: (required) The `OCID`__ of the work request. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param int limit: (optional) For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str page: (optional) For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str sort_order: (optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: "ASC", "DESC" :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.work_requests.models.WorkRequestError` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_work_request_errors API. z$/workRequests/{workRequestId}/errorsr1list_work_request_errorszbhttps://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequestError/ListWorkRequestErrorsr"r$limitpage sort_orderr3csg|]}|vr|qSr.r.r4r7r.r/r9r:z>WorkRequestClient.list_work_request_errors..z1list_work_request_errors got unknown kwargs: {!r}r;cSsi|]\}}|tur||qSr.r<r>r.r.r/rAr:z>WorkRequestClient.list_work_request_errors..NrrBrgASCDESC2Invalid value for `sort_order`, must be one of {0}rerfrerf sortOrdercSs&i|]\}}|tur|dur||qSrFr<r>r.r.r/rA+r:rCr3rDcSs&i|]\}}|tur|dur||qSrFr<r>r.r.r/rA2r:r$rGzlist[WorkRequestError]r" rKrLrM query_paramsrNrOr"rPrQrRr*rar,rKrLrPrQrbrMr?r@sort_order_allowed_valuesrnrNr$r.r7r/rcs~3$        z*WorkRequestClient.list_work_request_errorsc sd}d}d}d}gdfddt|D}|rBtd|d |i}d d t|D}t|D]:\} } | d ust| tjrht| d krhtd| qhd|vrddg} |d| vrtd| | dt | dt | dt d} dd t| D} dd| dt d} dd t| D} |j j | d|j d}|rt|tjsr|j | ||j|j|j j|||| | d| d||d S|j j|||| | d| d||d Sd S) a Gets the logs for a work request. :param str work_request_id: (required) The `OCID`__ of the work request. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param int limit: (optional) For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str page: (optional) For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str sort_order: (optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: "ASC", "DESC" :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.work_requests.models.WorkRequestLogEntry` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_work_request_logs API. z"/workRequests/{workRequestId}/logsr1list_work_request_logszchttps://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequestLogEntry/ListWorkRequestLogsrdcsg|]}|vr|qSr.r.r4r7r.r/r9r:z.z/list_work_request_logs got unknown kwargs: {!r}r;cSsi|]\}}|tur||qSr.r<r>r.r.r/rAr:z.NrrBrgrhrirjrerfrkcSs&i|]\}}|tur|dur||qSrFr<r>r.r.r/rAr:rCr3rDcSs&i|]\}}|tur|dur||qSrFr<r>r.r.r/rAr:r$rGzlist[WorkRequestLogEntry]r"rmrRror.r7r/rqTs~3$        z(WorkRequestClient.list_work_request_logsc s2d}d}d}d}gdfddt|D}|rBtd|||d t|d t|d td }d dt|D}dd|dtd} ddt| D} |jj|d|j d} | r t | t j s|j | | |j| j|jj|||| d|d||d S|jj|||| d|d||dSdS)a Lists the work requests in a compartment or for a specified resource. :param str compartment_id: (required) The `OCID`__ of the compartment. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param str resource_id: (optional) The `OCID`__ of the resource. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param int limit: (optional) For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str page: (optional) For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see `List Pagination`__. __ https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine :param str opc_request_id: (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param obj retry_strategy: (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the :py:mod:`~oci.retry` module. This operation will not retry by default, users can also use the convenient :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described `here `__. To have this operation explicitly not perform any retries, pass an instance of :py:class:`~oci.retry.NoneRetryStrategy`. :param bool allow_control_chars: (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings :return: A :class:`~oci.response.Response` object with data of type list of :class:`~oci.work_requests.models.WorkRequestSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_work_requests API. z /workRequestsr1list_work_requestsz_https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequestSummary/ListWorkRequests)r"r$ resource_idrerfr3csg|]}|vr|qSr.r.r4r7r.r/r9r:z8WorkRequestClient.list_work_requests..z+list_work_requests got unknown kwargs: {!r}rsrerf) compartmentId resourceIdrerfcSs&i|]\}}|tur|dur||qSrFr<r>r.r.r/rA%r:z8WorkRequestClient.list_work_requests..rCr3rDcSs&i|]\}}|tur|dur||qSrFr<r>r.r.r/rA,r:r$rGzlist[WorkRequestSummary]r")rKrLrnrNrOr"rPrQN)rrSrTrUr&r=rVr)r[r$rWrr\r]r^r%r_r`) r*compartment_idr,rKrLrPrQrbrnrNr$r.r7r/rrsd3        z$WorkRequestClient.list_work_requestsN) __name__ __module__ __qualname____doc__r0r2rcrqrrr.r.r.r/rs S_rN) __future__r oci._vendorrrocirroci.base_clientr oci.configrr oci.signerr oci.utilr r r modelsrr=objectrr.r.r.r/s