o ɶd@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)cloud_bridge_type_mappingZMissingc@s@eZdZdZddZddZddZdd Zd d Zd d Z dS) CommonClientz. API for Oracle Cloud Bridge service. c Kst||ddd|vr|d}n"t|vrt|}nt|d|d|d|dt|d|dd }d |d d d i|dd|dtj|dd}d|vrY|d|d<|dduretj|d<d|vrp|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 bool client_level_realm_specific_endpoint_template_enabled: (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None. :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 fingerprintZkey_file pass_phraseZ key_content)rrrZprivate_key_file_locationrZprivate_key_contentTservice_endpointz /20220509z4https://cloudbridge.{region}.oci.{secondLevelDomain}skip_deserializationFcircuit_breaker_strategy5client_level_realm_specific_endpoint_template_enabled)Zregional_clientr base_pathZservice_endpoint_templateZ#service_endpoint_template_per_realmrrrtimeoutNallow_control_charscommonretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr%Busr/lib/python3.10/site-packages/oci/cloud_bridge/common_client.py__init__s>3        zCommonClient.__init__c srdg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt | dt d} dd t| D} |j j | d|j d} | d urtj} | rt| tjs|j | | |j| j|j j||| | | d|||d S|j j||| | | d|||dS)a Cancels the work request with the given ID. :param str work_request_id: (required) The ID of the asynchronous request. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. :param str opc_request_id: (optional) The client request ID for tracing. :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 uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 None :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use cancel_work_request API. workRequestId/workRequests/{workRequestId}ZDELETEcancel_work_requestzPhttps://docs.oracle.com/iaas/api/#/en/OCB/20220509/WorkRequest/CancelWorkRequest)rrif_matchopc_request_idcg|]}|vr|qSr%r%.0_keyZexpected_kwargsr%r& z4CommonClient.cancel_work_request..z,cancel_work_request got unknown kwargs: {!r}cSi|] \}}|tur||qSr%missingr/kvr%r%r& z4CommonClient.cancel_work_request..Nr7Parameter {} cannot be None, whitespace or empty stringapplication/jsonr+r,)accept content-typezif-matchopc-request-idcS&i|]\}}|tur|dur||qSNr5r7r%r%r&r:&rZoperation_retry_strategyZclient_retry_strategyr) resource_pathmethod path_params header_paramsroperation_nameapi_reference_linkrequired_argumentsriterkeys ValueErrorformat iteritems isinstanceZ string_typeslenstripr r6r!get_preferred_retry_strategyrrDEFAULT_RETRY_STRATEGYNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_apir"work_request_idr$rKrErFrIrJ extra_kwargsrGr8r9rHrr%r1r&r*rsn%$      z CommonClient.cancel_work_requestc sldg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt d} dd t| D} |j j | d|j d} | d ur|tj} | rt| tjs|j | | |j| j|j j||| | d| d|||d S|j j||| | d| d|||d S)aA Gets details of the work request with the given ID. :param str work_request_id: (required) The ID of the asynchronous request. :param str opc_request_id: (optional) The client request ID for tracing. :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 uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.cloud_bridge.models.WorkRequest` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_work_request API. r(r)GETget_work_requestzMhttps://docs.oracle.com/iaas/api/#/en/OCB/20220509/WorkRequest/GetWorkRequest)rrr,cr-r%r%r.r1r%r&r2r3z1CommonClient.get_work_request..z)get_work_request got unknown kwargs: {!r}cSr4r%r5r7r%r%r&r:r;z1CommonClient.get_work_request..Nrr<r=r,r>r?r@cSrArBr5r7r%r%r&r:rCrrDZ WorkRequestr) rErFrGrH response_typerrIrJrKrLr[r%r1r&r_sp$     zCommonClient.get_work_requestc dg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7d|vridg} |d| vritd| d|vr~ddg} |d| vr~td| | dt | dt | dt | dt d}dd t|D}dd| dt d}dd t|D}|j j | d|j d}|d urtj}|rt|tjs|j |||j|j|j j||| ||d | d!|||d" S|j j||| ||d | d!|||d" S)#a Returns a (paginated) list of errors for the work request with the given ID. :param str work_request_id: (required) The ID of the asynchronous request. :param str opc_request_id: (optional) The client request ID for tracing. :param str page: (optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. :param int limit: (optional) The maximum number of items to return. :param str sort_by: (optional) The field to sort by. Only one sort order can be provided. By default, the order for timeAccepted is descending. Allowed values are: "timeAccepted" :param str sort_order: (optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: "ASC", "DESC" :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 uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.cloud_bridge.models.WorkRequestErrorCollection` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_work_request_errors API. r(z$/workRequests/{workRequestId}/errorsr^list_work_request_errorszYhttps://docs.oracle.com/iaas/api/#/en/OCB/20220509/WorkRequestError/ListWorkRequestErrorsrrr,pagelimitsort_by sort_ordercr-r%r%r.r1r%r&r2{r3z9CommonClient.list_work_request_errors..z1list_work_request_errors got unknown kwargs: {!r}cSr4r%r5r7r%r%r&r:r;z9CommonClient.list_work_request_errors..Nrr<rg timeAccepted/Invalid value for `sort_by`, must be one of {0}rhASCDESC2Invalid value for `sort_order`, must be one of {0}rerfrerfsortBy sortOrdercSrArBr5r7r%r%r&r:rCr=r,r`cSrArBr5r7r%r%r&r:rCrrDZWorkRequestErrorCollectionr rErFrG query_paramsrHrarrIrJrKrLr"r\r$rKrErFrIrJr]rGr8r9sort_by_allowed_valuessort_order_allowed_valuesrrrHrr%r1r&rc=. $           z%CommonClient.list_work_request_errorsc rb)#a Returns a (paginated) list of logs for the work request with the given ID. :param str work_request_id: (required) The ID of the asynchronous request. :param str opc_request_id: (optional) The client request ID for tracing. :param str page: (optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. :param int limit: (optional) The maximum number of items to return. :param str sort_by: (optional) The field to sort by. Only one sort order can be provided. By default, the order for timeAccepted is descending. Allowed values are: "timeAccepted" :param str sort_order: (optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: "ASC", "DESC" :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 uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.cloud_bridge.models.WorkRequestLogEntryCollection` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_work_request_logs API. r(z"/workRequests/{workRequestId}/logsr^list_work_request_logszZhttps://docs.oracle.com/iaas/api/#/en/OCB/20220509/WorkRequestLogEntry/ListWorkRequestLogsrdcr-r%r%r.r1r%r&r2 r3z7CommonClient.list_work_request_logs..z/list_work_request_logs got unknown kwargs: {!r}cSr4r%r5r7r%r%r&r:r;z7CommonClient.list_work_request_logs..Nrr<rgrirjrhrkrlrmrerfrncSrArBr5r7r%r%r&r:,rCr=r,r`cSrArBr5r7r%r%r&r:3rCrrDZWorkRequestLogEntryCollectionrrqrLrsr%r1r&rwrvz#CommonClient.list_work_request_logsc sdg}d}d}d}d}gdfddt|D}|r$td |d |vr9gd } |d | vr9td | d |vrNddg} |d | vrNtd| d|vrbdg} |d| vrbtd| ||dt|d t|dt|dt|dt|d t|dtd} ddt| D} dd|dtd} ddt| D} |jj|d|j d }|d!urt j }|rt |t j s|j| ||j|j|jj||| | d"|d#|||d$ S|jj||| | d"|d#|||d$ S)%a Lists the work requests in a compartment. :param str compartment_id: (required) The ID of the compartment in which to list resources. :param str work_request_id: (optional) The ID of the asynchronous work request. :param str status: (optional) A filter to return only resources for which the lifecycleState matches the given OperationStatus. Allowed values are: "ACCEPTED", "IN_PROGRESS", "WAITING", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED" :param str resource_id: (optional) The ID of the resource affected by the work request. :param str opc_request_id: (optional) The client request ID for tracing. :param str page: (optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. :param int limit: (optional) The maximum number of items to return. :param str sort_order: (optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: "ASC", "DESC" :param str sort_by: (optional) The field to sort by. Only one sort order can be provided. By default, the order for timeAccepted is descending. Allowed values are: "timeAccepted" :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 uses :py:data:`~oci.retry.DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.cloud_bridge.models.WorkRequestSummaryCollection` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_work_requests API. compartmentIdz /workRequestsr^list_work_requestszOhttps://docs.oracle.com/iaas/api/#/en/OCB/20220509/WorkRequest/ListWorkRequests) rrr\status resource_idr,rerfrhrgcr-r%r%r.r1r%r&r2r3z3CommonClient.list_work_requests..z+list_work_requests got unknown kwargs: {!r}rz)ZACCEPTEDZ IN_PROGRESSZWAITINGZFAILEDZ SUCCEEDEDZ CANCELINGZCANCELEDz.Invalid value for `status`, must be one of {0}rhrkrlrmrgrirjr\r{rerf)rxr(rzZ resourceIdrerfrprocSrArBr5r7r%r%r&r:rCz3CommonClient.list_work_requests..r=r,r`cSrArBr5r7r%r%r&r:rCrrDNZWorkRequestSummaryCollectionr) rErFrrrHrarrIrJrK)rrMrNrOr r6rPr!rTrrrUrQrVrWrXrrYrZ)r"Zcompartment_idr$rKrErFrIrJr]Zstatus_allowed_valuesrurtrrrHrr%r1r&ryYs9                 zCommonClient.list_work_requestsN) __name__ __module__ __qualname____doc__r'r*r_rcrwryr%r%r%r&rsXib rN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr6objectrr%r%r%r&s