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)mysql_type_mappingZMissingc@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS)ChannelsClientz0 The API for the MySQL Database 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 /20190415z.https://mysql.{region}.ocp.{secondLevelDomain}skip_deserializationFcircuit_breaker_strategy5client_level_realm_specific_endpoint_template_enabled)Zregional_clientr base_pathZservice_endpoint_templateZ#service_endpoint_template_per_realmrrrtimeoutNallow_control_charsZchannelsretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr$=usr/lib/python3.10/site-packages/oci/mysql/channels_client.py__init__s>3        zChannelsClient.__init__c sg}d}d}d}d}gdfddt|D}|r#td|d d |d t|d td } d dt| D} |jj|d|j d} | durOt j } | r}t | t j si|j| |j| | |j| j|jj||| |d|d|||d S|jj||| |d|d|||d S)a' Creates a Channel to establish replication from a source to a target. :param oci.mysql.models.CreateChannelDetails create_channel_details: (required) The parameters of the request to create the Channel. :param str opc_request_id: (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). :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.mysql.models.Channel` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use create_channel API. /channelsPOSTcreate_channel)rropc_request_idopc_retry_tokencg|]}|vr|qSr$r$.0_keyZexpected_kwargsr$r% z1ChannelsClient.create_channel..z'create_channel got unknown kwargs: {!r}application/jsonr+r,)accept content-typeopc-request-idopc-retry-tokencS&i|]\}}|tur|dur||qSNmissingr/kvr$r$r% &z1ChannelsClient.create_channel..rZoperation_retry_strategyZclient_retry_strategyNChannelr) resource_pathmethod header_paramsbody response_typeroperation_nameapi_reference_linkrequired_arguments)riterkeys ValueErrorformatrr< iteritemsr get_preferred_retry_strategyrrDEFAULT_RETRY_STRATEGY isinstanceNoneRetryStrategyadd_opc_retry_token_if_neededadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api) r!Zcreate_channel_detailsr#rKrDrErIrJ extra_kwargsrFrr$r1r%r)rsf(       zChannelsClient.create_channelc 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} Deletes the specified Channel. :param str channel_id: (required) The Channel `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header 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) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :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 delete_channel API. channelId/channels/{channelId}ZDELETEdelete_channelzJhttps://docs.oracle.com/iaas/api/#/en/mysql/20190415/Channel/DeleteChannel)rrif_matchr+cr-r$r$r.r1r$r%r2 r3z1ChannelsClient.delete_channel..z'delete_channel got unknown kwargs: {!r}cSi|] \}}|tur||qSr$r;r=r$r$r%r@z1ChannelsClient.delete_channel..Nr7Parameter {} cannot be None, whitespace or empty stringr4r]r+)r5r6if-matchr7cSr9r:r;r=r$r$r%r@"rArrBrrDrE path_paramsrFrrIrJrKrrLrMrNrOrR string_typeslenstriprr<r rPrrrQrSrUrVrrWrXr! channel_idr#rKrDrErIrJrYrcr>r?rFrr$r1r%r\sn)$      zChannelsClient.delete_channelc svdg}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|||d S|j j||| | d| d|||d S)az Gets the full details of the specified Channel, including the user-specified configuration parameters (passwords are omitted), as well as information about the state of the Channel, its sources and targets. :param str channel_id: (required) The Channel `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :param str if_none_match: (optional) For conditional requests. In the GET call for a resource, set the `If-None-Match` header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation. :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.mysql.models.Channel` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_channel API. rZr[GET get_channelzGhttps://docs.oracle.com/iaas/api/#/en/mysql/20190415/Channel/GetChannel)rrr+ if_none_matchcr-r$r$r.r1r$r%r2|r3z.ChannelsClient.get_channel..z$get_channel got unknown kwargs: {!r}cSr^r$r;r=r$r$r%r@r_z.ChannelsClient.get_channel..Nrr`r4r+rl)r5r6r7z if-none-matchcSr9r:r;r=r$r$r%r@rArrBrCr) rDrErcrFrHrrIrJrKrdrhr$r1r%rkDsr+$      zChannelsClient.get_channelc sdg}d}d}d}d}gdfddt|D}|r$td |d |vr9gd } |d | vr9td | d |vrNddg} |d | vrNtd| d|vrcddg} |d| vrctd| ||dt|dt|dt|d t|dt|d t|dt|dt|dtd } ddt| D} dd|dtd } d!dt| 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 all the Channels that match the specified filters. :param str compartment_id: (required) The compartment `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str opc_request_id: (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :param str db_system_id: (optional) The DB System `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str channel_id: (optional) The OCID of the Channel. :param str display_name: (optional) A filter to return only the resource matching the given display name exactly. :param str lifecycle_state: (optional) The LifecycleState of the Channel. Allowed values are: "CREATING", "ACTIVE", "NEEDS_ATTENTION", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" :param bool is_enabled: (optional) If true, returns only Channels that are enabled. If false, returns only Channels that are disabled. :param str sort_by: (optional) The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending. Allowed values are: "displayName", "timeCreated" :param str sort_order: (optional) The sort order to use (ASC or DESC). Allowed values are: "ASC", "DESC" :param int limit: (optional) The maximum number of items to return in a paginated list call. For information about pagination, see `List Pagination`__. __ https://docs.cloud.oracle.com/#API/Concepts/usingapi.htm#List_Pagination :param str page: (optional) The value of the `opc-next-page` or `opc-prev-page` response header from the previous list call. For information about pagination, see `List Pagination`__. __ https://docs.cloud.oracle.com/#API/Concepts/usingapi.htm#List_Pagination :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 list of :class:`~oci.mysql.models.ChannelSummary` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_channels API. compartmentIdr'rj list_channelszPhttps://docs.oracle.com/iaas/api/#/en/mysql/20190415/ChannelSummary/ListChannels) rrr+ db_system_idri display_namelifecycle_state is_enabledsort_by sort_orderlimitpagecr-r$r$r.r1r$r%r2r3z0ChannelsClient.list_channels..z&list_channels got unknown kwargs: {!r}rq)ZCREATINGZACTIVEZNEEDS_ATTENTIONZINACTIVEZUPDATINGZDELETINGZDELETEDZFAILEDz7Invalid value for `lifecycle_state`, must be one of {0}rs displayNameZ timeCreatedz/Invalid value for `sort_by`, must be one of {0}rtZASCZDESCz2Invalid value for `sort_order`, must be one of {0}rorirprrrurv) rmZ dbSystemIdrZrwZlifecycleStateZ isEnabledZsortByZ sortOrderrurvcSr9r:r;r=r$r$r%r@=rAz0ChannelsClient.list_channels..r4r+)r5r6r7cSr9r:r;r=r$r$r%r@DrArrBNzlist[ChannelSummary]r) rDrE query_paramsrFrHrrIrJrK)rrLrMrNrr<rOr rPrrrQrRrSrUrVrrWrX)r!Zcompartment_idr#rKrDrErIrJrYZlifecycle_state_allowed_valuesZsort_by_allowed_valuesZsort_order_allowed_valuesrxrFrr$r1r%rnsM                  zChannelsClient.list_channelsc dg}d}d}d}d}gdfddt|D}|r$td |d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt | dt | dt d} dd t| D} |j j | d|j d} | d urtj} | rt| tjs|j | |j | | |j| j|j j||| | | d|||d S|j j||| | | d|||dS)a Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created. This operation is only accepted in Inactive Channels. :param str channel_id: (required) The Channel `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header 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) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). :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 reset_channel API. rZz#/channels/{channelId}/actions/resetr( reset_channelzIhttps://docs.oracle.com/iaas/api/#/en/mysql/20190415/Channel/ResetChannelrrr]r+r,cr-r$r$r.r1r$r%r2r3z0ChannelsClient.reset_channel..z&reset_channel got unknown kwargs: {!r}cSr^r$r;r=r$r$r%r@r_z0ChannelsClient.reset_channel..Nrr`r4r]r+r,r5r6rar7r8cSr9r:r;r=r$r$r%r@rArrBrrbrrLrMrNrOrRrerfrgrr<r rPrrrQrSrTrUrVrrWrXrhr$r1r%rzhsr2$        zChannelsClient.reset_channelc ry)aA Resumes an enabled Channel that has become Inactive due to an error. The resume operation requires that the error that cause the Channel to become Inactive has already been fixed, otherwise the operation may fail. :param str channel_id: (required) The Channel `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header 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) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). :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 resume_channel API. rZz$/channels/{channelId}/actions/resumer(resume_channelzJhttps://docs.oracle.com/iaas/api/#/en/mysql/20190415/Channel/ResumeChannelr{cr-r$r$r.r1r$r%r2"r3z1ChannelsClient.resume_channel..z'resume_channel got unknown kwargs: {!r}cSr^r$r;r=r$r$r%r@+r_z1ChannelsClient.resume_channel..Nrr`r4r]r+r,r|cSr9r:r;r=r$r$r%r@8rArrBrrbr}rhr$r1r%r~sr3$        zChannelsClient.resume_channelc sdg}d}d}d}d}gdfddt|D} | r$td | d|i} d d t| D} t| D]\} } | d usMt| tjrTt| d krTtd| q7dd| dt | dt | dt d} dd t| D} |j j | d|j d}|d urtj}|rt|tjs|j | |j | ||j|j|j j||| | || d|||d S|j j||| | || d|||d S)aE Updates the properties of the specified Channel. If the Channel is Active the Update operation will asynchronously apply the new configuration parameters to the Channel and the Channel may become temporarily unavailable. Otherwise, the new configuration will be applied the next time the Channel becomes Active. :param str channel_id: (required) The Channel `OCID`__. __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm :param oci.mysql.models.UpdateChannelDetails update_channel_details: (required) The parameters of the request to update the Channel. :param str if_match: (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `If-Match` header 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) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. :param str opc_retry_token: (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). :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 update_channel API. rZr[ZPUTupdate_channelzJhttps://docs.oracle.com/iaas/api/#/en/mysql/20190415/Channel/UpdateChannelr{cr-r$r$r.r1r$r%r2r3z1ChannelsClient.update_channel..z'update_channel got unknown kwargs: {!r}cSr^r$r;r=r$r$r%r@r_z1ChannelsClient.update_channel..Nrr`r4r]r+r,r|cSr9r:r;r=r$r$r%r@rArrBr) rDrErcrFrGrrIrJrKr})r!riZupdate_channel_detailsr#rKrDrErIrJrYrcr>r?rFrr$r1r%r[sv7$        zChannelsClient.update_channelN) __name__ __module__ __qualname____doc__r&r)r\rkrnrzr~rr$r$r$r%rsXemq4y zrN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr<objectrr$r$r$r%s