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)dashboard_service_type_mappingZMissingc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)DashboardClienta Use the Oracle Cloud Infrastructure Dashboards service API to manage dashboards in the Console. Dashboards provide an organized and customizable view of resources and their metrics in the Console. For more information, see [Dashboards](/Content/Dashboards/home.htm). **Important:** Resources for the Dashboards service are created in the tenacy's home region. Although it is possible to create dashboard and dashboard group resources in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended. 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 /20210731z2https://dashboard.{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_charsZ dashboardretry_strategycircuit_breaker_callback)r getr r r rrZGLOBAL_CIRCUIT_BREAKER_STRATEGYZ DEFAULT_CIRCUIT_BREAKER_STRATEGYrr base_clientrr)selfconfigkwargsrZbase_client_init_kwargsr$Jusr/lib/python3.10/site-packages/oci/dashboard_service/dashboard_client.py__init__!s>3        zDashboardClient.__init__c shdg}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}|rt|tjs|j | ||j|j|j j||| | || d|||d S|j j||| | || d|||d S)a Moves a Dashboard resource from one dashboardGroup identifier to another. When provided, If-Match is checked against ETag values of the resource. :param str dashboard_id: (required) The `OCID`__ of the dashboard. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param oci.dashboard_service.models.ChangeDashboardGroupDetails change_dashboard_group_details: (required) The information to be updated. :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) 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 None :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use change_dashboard_group API. dashboardIdz6/dashboards/{dashboardId}/actions/changeDashboardGroupPOSTchange_dashboard_groupzWhttps://docs.oracle.com/iaas/api/#/en/dashboard/20210731/Dashboard/ChangeDashboardGroup)rrif_matchopc_request_idcg|]}|vr|qSr$r$.0_keyZexpected_kwargsr$r% z:DashboardClient.change_dashboard_group..z/change_dashboard_group got unknown kwargs: {!r}cSi|] \}}|tur||qSr$missingr.kvr$r$r% z:DashboardClient.change_dashboard_group..Nr7Parameter {} cannot be None, whitespace or empty stringapplication/jsonr*r+)accept content-typeif-matchopc-request-idcS&i|]\}}|tur|dur||qSNr4r6r$r$r%r9&rZoperation_retry_strategyZclient_retry_strategyr) resource_pathmethod path_params header_paramsbodyroperation_nameapi_reference_linkrequired_argumentsriterkeys ValueErrorformat iteritems isinstance string_typeslenstriprr5r get_preferred_retry_strategyrrNoneRetryStrategyadd_opc_client_retries_headeradd_circuit_breaker_callbackrmake_retrying_callcall_api)r! dashboard_idZchange_dashboard_group_detailsr#rLrErFrJrK extra_kwargsrGr7r8rHrr$r0r%r)ysn*$      z&DashboardClient.change_dashboard_groupc sg}d}d}d}d}gdfddt|D}|r#td|d d |d t|d t|d td } ddt| D} |jj|d|j d} | r{t | t j sg|j | |j| | |j| j|jj||| |d|d|||d S|jj||| |d|d|||d S)aZ Creates a new dashboard in the dashboard group's compartment using the details provided in request body. **Caution:** Resources for the Dashboard service are created in the tenacy's home region. Although it is possible to create dashboard resource in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended. :param oci.dashboard_service.models.CreateDashboardDetails create_dashboard_details: (required) Details about the dashboard being created. :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 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 str opc_cross_region: (optional) To identify if the call is cross-regional. In CRUD calls for a resource, to identify that the call originates from different region, set the `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned. :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.dashboard_service.models.Dashboard` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use create_dashboard API. /dashboardsr(create_dashboardzRhttps://docs.oracle.com/iaas/api/#/en/dashboard/20210731/Dashboard/CreateDashboard)rropc_retry_tokenr+opc_cross_regioncr,r$r$r-r0r$r%r1&r2z4DashboardClient.create_dashboard..z)create_dashboard got unknown kwargs: {!r}r<r`r+ra)r=r>zopc-retry-tokenr@opc-cross-regioncSrArBr4r6r$r$r%r92rCz4DashboardClient.create_dashboard..rrD Dashboardr) rErFrHrI response_typerrJrKrL)rrNrOrPrr5rQr rVrrRrrWZadd_opc_retry_token_if_neededrXrYrrZr[) r!Zcreate_dashboard_detailsr#rLrErFrJrKr]rHrr$r0r%r_sd1        z DashboardClient.create_dashboardc sndg}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} | rt| tjs|j | | |j| j|j j||| | | d|||d S|j j||| | | d|||dS)a~ Deletes the specified dashboard. Uses the dashboard's OCID to determine which dashboard to delete. :param str dashboard_id: (required) The `OCID`__ of the dashboard. __ https://docs.cloud.oracle.com/iaas/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` 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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str opc_cross_region: (optional) To identify if the call is cross-regional. In CRUD calls for a resource, to identify that the call originates from different region, set the `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned. :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 None :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use delete_dashboard API. r'/dashboards/{dashboardId}ZDELETEdelete_dashboardzRhttps://docs.oracle.com/iaas/api/#/en/dashboard/20210731/Dashboard/DeleteDashboardrrr*r+racr,r$r$r-r0r$r%r1r2z4DashboardClient.delete_dashboard..z)delete_dashboard got unknown kwargs: {!r}cSr3r$r4r6r$r$r%r9r:z4DashboardClient.delete_dashboard..Nrr;r<r*r+rar=r>r?r@rbcSrArBr4r6r$r$r%r9rCrrDr)rErFrGrHrrJrKrLrMr!r\r#rLrErFrJrKr]rGr7r8rHrr$r0r%rfUsl.$       z DashboardClient.delete_dashboardc 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)a Gets the specified dashboard's information. Uses the dashboard's OCID to determine which dashboard to retrieve. :param str dashboard_id: (required) The `OCID`__ of the dashboard. __ 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 str opc_cross_region: (optional) To identify if the call is cross-regional. In CRUD calls for a resource, to identify that the call originates from different region, set the `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned. :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.dashboard_service.models.Dashboard` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use get_dashboard API. r'reGET get_dashboardzOhttps://docs.oracle.com/iaas/api/#/en/dashboard/20210731/Dashboard/GetDashboard)rrr+racr,r$r$r-r0r$r%r1r2z1DashboardClient.get_dashboard..z&get_dashboard got unknown kwargs: {!r}cSr3r$r4r6r$r$r%r9r:z1DashboardClient.get_dashboard..Nrr;r<r+rar=r>r@rbcSrArBr4r6r$r$r%r9rCrrDrcr) rErFrGrHrdrrJrKrL)rrNrOrPrQrRrSrTrUrr5r rVrrDEFAULT_RETRY_STRATEGYrWrXrYrrZr[rir$r0r%rksr'$      zDashboardClient.get_dashboardc sdg}d}d}d}d}gdfddt|D}|r$td |d |vr9gd } |d | vr9td | d |vrNddg} |d | vrNtd| d|vrcddg} |d| vrctd| ||d t|dt|dt|dt|dt|d t|dtd} ddt| D} dd|dt|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)'aB Returns a list of dashboards with a specific dashboard group ID. :param str dashboard_group_id: (required) The `OCID`__ of the dashboard group that the dashboard belongs to. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param str lifecycle_state: (optional) A filter that returns dashboard resources that match the lifecycle state specified. Allowed values are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" :param str display_name: (optional) A case-sensitive filter that returns resources that match the entire display name specified. :param str id: (optional) The `OCID`__ of the dashboard. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param int limit: (optional) The maximum number of items to return. :param str page: (optional) The page token representing the page at which to start retrieving results. This value is usually retrieved from a previous list call. :param str sort_order: (optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: "ASC", "DESC" :param str sort_by: (optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Allowed values are: "timeCreated", "displayName" :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 str opc_cross_region: (optional) To identify if the call is cross-regional. In CRUD calls for a resource, to identify that the call originates from different region, set the `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned. :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.dashboard_service.models.DashboardCollection` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use list_dashboards API. dashboardGroupIdr^rjlist_dashboardsz[https://docs.oracle.com/iaas/api/#/en/dashboard/20210731/DashboardCollection/ListDashboards) rrlifecycle_state display_nameidlimitpage sort_ordersort_byr+racr,r$r$r-r0r$r%r1r2z3DashboardClient.list_dashboards..z(list_dashboards got unknown kwargs: {!r}rp)ZCREATINGZUPDATINGZACTIVEZDELETINGZDELETEDZFAILEDz7Invalid value for `lifecycle_state`, must be one of {0}ruZASCZDESCz2Invalid value for `sort_order`, must be one of {0}rvZ timeCreated displayNamez/Invalid value for `sort_by`, must be one of {0}rqrrrsrt)rnZlifecycleStaterwrrrsrtZ sortOrderZsortBycSrArBr4r6r$r$r%r9rCz3DashboardClient.list_dashboards..r<r+rarlcSrArBr4r6r$r$r%r9rCrrDNZDashboardCollectionr) rErF query_paramsrHrdrrJrKrL)rrNrOrPrr5rQr rVrrrmrRrWrXrYrrZr[)r!Zdashboard_group_idr#rLrErFrJrKr]Zlifecycle_state_allowed_valuesZsort_order_allowed_valuesZsort_by_allowed_valuesrxrHrr$r0r%ro4sG                  zDashboardClient.list_dashboardsc 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 | dt d} dd t| D} |j j | d|j d}|rt|tjs|j | ||j|j|j j||| | |d| d|||d S|j j||| | |d| d|||d S)aD Updates the specified dashboard. Uses the dashboard's OCID to determine which dashboard to update. :param str dashboard_id: (required) The `OCID`__ of the dashboard. __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm :param oci.dashboard_service.models.UpdateDashboardDetails update_dashboard_details: (required) The dashboard details to be updated. :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) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. :param str opc_cross_region: (optional) To identify if the call is cross-regional. In CRUD calls for a resource, to identify that the call originates from different region, set the `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`) The call will be served from a Replicated bucket. For same-region calls, the value is unassigned. :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.dashboard_service.models.Dashboard` :rtype: :class:`~oci.response.Response` :example: Click `here `__ to see an example of how to use update_dashboard API. r'reZPUTupdate_dashboardzRhttps://docs.oracle.com/iaas/api/#/en/dashboard/20210731/Dashboard/UpdateDashboardrgcr,r$r$r-r0r$r%r1r2z4DashboardClient.update_dashboard..z)update_dashboard got unknown kwargs: {!r}cSr3r$r4r6r$r$r%r9'r:z4DashboardClient.update_dashboard..Nrr;r<r*r+rarhcSrArBr4r6r$r$r%r94rCrrDrcr) rErFrGrHrIrdrrJrKrLrM)r!r\Zupdate_dashboard_detailsr#rLrErFrJrKr]rGr7r8rHrr$r0r%ryst1$       z DashboardClient.update_dashboardN) __name__ __module__ __qualname____doc__r&r)r_rfrkroryr$r$r$r%rs Xnnrm ,rN) __future__rZ oci._vendorrrocirrZoci.base_clientrZ oci.configrr Z oci.signerr Zoci.utilr r r Zmodelsrr5objectrr$r$r$r%s