class OCI::ManagementDashboard::DashxApisClient
API for the Management Dashboard micro-service. Use this API for dashboard and saved search metadata preservation and to perform tasks such as creating a dashboard, creating a saved search, and obtaining a list of dashboards and saved searches in a compartment.
Attributes
Client used to make HTTP requests. @return [OCI::ApiClient]
Fully qualified endpoint URL @return [String]
The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]
Public Class Methods
Creates a new DashxApisClient
. Notes:
If a config is not specified, then the global OCI.config will be used. This client is not thread-safe Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
@param [Config] config A Config
object. @param [String] region A region used to determine the service endpoint. This will usually
correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client
@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests
the details for the proxy can be provided in this parameter
@param [OCI::Retry::RetryConfig] retry_config
The retry configuration for this service client. This represents the default retry configuration to
apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 54 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20200901' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "DashxApisClient endpoint set to '#{@endpoint}'." if logger end
Public Instance Methods
Moves the dashboard from the existing compartment to a new compartment.
@param [String] management_dashboard_id A unique dashboard identifier. @param [OCI::ManagementDashboard::Models::ChangeManagementDashboardsCompartmentDetails] change_management_dashboards_compartment_details ID of the dashboard that is being moved. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/change_management_dashboards_compartment.rb.html) to see an example of how to use change_management_dashboards_compartment
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 124 def change_management_dashboards_compartment(management_dashboard_id, change_management_dashboards_compartment_details, opts = {}) logger.debug 'Calling operation DashxApisClient#change_management_dashboards_compartment.' if logger raise "Missing the required parameter 'management_dashboard_id' when calling change_management_dashboards_compartment." if management_dashboard_id.nil? raise "Missing the required parameter 'change_management_dashboards_compartment_details' when calling change_management_dashboards_compartment." if change_management_dashboards_compartment_details.nil? raise "Parameter value for 'management_dashboard_id' must not be blank" if OCI::Internal::Util.blank_string?(management_dashboard_id) path = '/managementDashboards/{managementDashboardId}/actions/changeCompartment'.sub('{managementDashboardId}', management_dashboard_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_management_dashboards_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#change_management_dashboards_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Moves the saved search from the existing compartment to a new compartment.
@param [String] management_saved_search_id A unique saved search identifier. @param [OCI::ManagementDashboard::Models::ChangeManagementSavedSearchesCompartmentDetails] change_management_saved_searches_compartment_details ID of the saved search that is being moved. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/change_management_saved_searches_compartment.rb.html) to see an example of how to use change_management_saved_searches_compartment
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 195 def change_management_saved_searches_compartment(management_saved_search_id, change_management_saved_searches_compartment_details, opts = {}) logger.debug 'Calling operation DashxApisClient#change_management_saved_searches_compartment.' if logger raise "Missing the required parameter 'management_saved_search_id' when calling change_management_saved_searches_compartment." if management_saved_search_id.nil? raise "Missing the required parameter 'change_management_saved_searches_compartment_details' when calling change_management_saved_searches_compartment." if change_management_saved_searches_compartment_details.nil? raise "Parameter value for 'management_saved_search_id' must not be blank" if OCI::Internal::Util.blank_string?(management_saved_search_id) path = '/managementSavedSearches/{managementSavedSearchId}/actions/changeCompartment'.sub('{managementSavedSearchId}', management_saved_search_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_management_saved_searches_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#change_management_saved_searches_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Creates a new dashboard. Limit for number of saved searches in a dashboard is 20. To get an example of what needs to be passed to CREATE, one can use GET API. oci management-dashboard dashboard get –management-dashboard-id "ocid1.managementdashboard.oc1..dashboardId1" –query data > Create.json
Modify the Create.json by removing "id" attribute and other desired changes, then do oci management-dashboard dashboard create –from-json file://Create.json
@param [OCI::ManagementDashboard::Models::CreateManagementDashboardDetails] create_management_dashboard_details JSON metadata for creating a new dashboard. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementDashboard ManagementDashboard} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/create_management_dashboard.rb.html) to see an example of how to use create_management_dashboard
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 263 def create_management_dashboard(create_management_dashboard_details, opts = {}) logger.debug 'Calling operation DashxApisClient#create_management_dashboard.' if logger raise "Missing the required parameter 'create_management_dashboard_details' when calling create_management_dashboard." if create_management_dashboard_details.nil? path = '/managementDashboards' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_management_dashboard_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#create_management_dashboard') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementDashboard' ) end # rubocop:enable Metrics/BlockLength end
Creates a new saved search. To get an example of what needs to be passed to CREATE, one can use GET API. oci management-dashboard saved-search get –management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 –query data > Create.json
Modify the Create.json by removing "id" attribute and other desired changes, then do oci management-dashboard saved-search create –from-json file://Create.json
@param [OCI::ManagementDashboard::Models::CreateManagementSavedSearchDetails] create_management_saved_search_details JSON metadata for the saved search. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementSavedSearch ManagementSavedSearch} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/create_management_saved_search.rb.html) to see an example of how to use create_management_saved_search
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 329 def create_management_saved_search(create_management_saved_search_details, opts = {}) logger.debug 'Calling operation DashxApisClient#create_management_saved_search.' if logger raise "Missing the required parameter 'create_management_saved_search_details' when calling create_management_saved_search." if create_management_saved_search_details.nil? path = '/managementSavedSearches' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_management_saved_search_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#create_management_saved_search') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementSavedSearch' ) end # rubocop:enable Metrics/BlockLength end
Deletes a Dashboard by ID. @param [String] management_dashboard_id A unique dashboard identifier. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/delete_management_dashboard.rb.html) to see an example of how to use delete_management_dashboard
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 390 def delete_management_dashboard(management_dashboard_id, opts = {}) logger.debug 'Calling operation DashxApisClient#delete_management_dashboard.' if logger raise "Missing the required parameter 'management_dashboard_id' when calling delete_management_dashboard." if management_dashboard_id.nil? raise "Parameter value for 'management_dashboard_id' must not be blank" if OCI::Internal::Util.blank_string?(management_dashboard_id) path = '/managementDashboards/{managementDashboardId}'.sub('{managementDashboardId}', management_dashboard_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#delete_management_dashboard') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Deletes a saved search by ID. @param [String] management_saved_search_id A unique saved search identifier. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/delete_management_saved_search.rb.html) to see an example of how to use delete_management_saved_search
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 450 def delete_management_saved_search(management_saved_search_id, opts = {}) logger.debug 'Calling operation DashxApisClient#delete_management_saved_search.' if logger raise "Missing the required parameter 'management_saved_search_id' when calling delete_management_saved_search." if management_saved_search_id.nil? raise "Parameter value for 'management_saved_search_id' must not be blank" if OCI::Internal::Util.blank_string?(management_saved_search_id) path = '/managementSavedSearches/{managementSavedSearchId}'.sub('{managementSavedSearchId}', management_saved_search_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#delete_management_saved_search') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. An example using OCI
CLI is $oci management-dashboard dashboard export –query data –export-dashboard-id "{\"dashboardIds\":}" > dashboards.json $oci management-dashboard dashboard import –from-json file://dashboards.json @param [String] export_dashboard_id List of dashboardIds in plain text. The syntaxt is '{"dashboardIds":["dashboardId1", "dashboardId2", …]}'. Escaping is needed when using in OCI
CLI. For example, "{\"dashboardIds\":}" . @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementDashboardExportDetails ManagementDashboardExportDetails} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/export_dashboard.rb.html) to see an example of how to use export_dashboard
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 510 def export_dashboard(export_dashboard_id, opts = {}) logger.debug 'Calling operation DashxApisClient#export_dashboard.' if logger raise "Missing the required parameter 'export_dashboard_id' when calling export_dashboard." if export_dashboard_id.nil? raise "Parameter value for 'export_dashboard_id' must not be blank" if OCI::Internal::Util.blank_string?(export_dashboard_id) path = '/managementDashboards/actions/exportDashboard/{exportDashboardId}'.sub('{exportDashboardId}', export_dashboard_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#export_dashboard') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementDashboardExportDetails' ) end # rubocop:enable Metrics/BlockLength end
Gets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property. @param [String] management_dashboard_id A unique dashboard identifier. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementDashboard ManagementDashboard} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/get_management_dashboard.rb.html) to see an example of how to use get_management_dashboard
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 572 def get_management_dashboard(management_dashboard_id, opts = {}) logger.debug 'Calling operation DashxApisClient#get_management_dashboard.' if logger raise "Missing the required parameter 'management_dashboard_id' when calling get_management_dashboard." if management_dashboard_id.nil? raise "Parameter value for 'management_dashboard_id' must not be blank" if OCI::Internal::Util.blank_string?(management_dashboard_id) path = '/managementDashboards/{managementDashboardId}'.sub('{managementDashboardId}', management_dashboard_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#get_management_dashboard') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementDashboard' ) end # rubocop:enable Metrics/BlockLength end
Gets a saved search by ID. @param [String] management_saved_search_id A unique saved search identifier. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementSavedSearch ManagementSavedSearch} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/get_management_saved_search.rb.html) to see an example of how to use get_management_saved_search
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 634 def get_management_saved_search(management_saved_search_id, opts = {}) logger.debug 'Calling operation DashxApisClient#get_management_saved_search.' if logger raise "Missing the required parameter 'management_saved_search_id' when calling get_management_saved_search." if management_saved_search_id.nil? raise "Parameter value for 'management_saved_search_id' must not be blank" if OCI::Internal::Util.blank_string?(management_saved_search_id) path = '/managementSavedSearches/{managementSavedSearchId}'.sub('{managementSavedSearchId}', management_saved_search_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#get_management_saved_search') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementSavedSearch' ) end # rubocop:enable Metrics/BlockLength end
Imports an array of dashboards and their saved searches. Import is designed to work with exportDashboard. An example using OCI
CLI is
$oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > dashboards.json $oci management-dashboard dashboard import --from-json file://dashboards.json
@param [OCI::ManagementDashboard::Models::ManagementDashboardImportDetails] management_dashboard_import_details JSON metadata for importing dashboards and their saved searches. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/import_dashboard.rb.html) to see an example of how to use import_dashboard
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 705 def import_dashboard(management_dashboard_import_details, opts = {}) logger.debug 'Calling operation DashxApisClient#import_dashboard.' if logger raise "Missing the required parameter 'management_dashboard_import_details' when calling import_dashboard." if management_dashboard_import_details.nil? path = '/managementDashboards/actions/importDashboard' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(management_dashboard_import_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#import_dashboard') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end
Gets the list of dashboards in a compartment with pagination. Returned properties are the summary. @param [String] compartment_id The ID of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :display_name A filter to return only resources that match the entire display name given. @option opts [String] :opc_request_id The client request ID for tracing. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @option opts [String] :page The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call. @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. (default to ASC) @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is the default.
(default to timeCreated) Allowed values are: timeCreated, displayName
@return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementDashboardCollection ManagementDashboardCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/list_management_dashboards.rb.html) to see an example of how to use list_management_dashboards
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 767 def list_management_dashboards(compartment_id, opts = {}) logger.debug 'Calling operation DashxApisClient#list_management_dashboards.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_dashboards." if compartment_id.nil? if opts[:sort_order] && !OCI::ManagementDashboard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ManagementDashboard::Models::SORT_ORDERS_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/managementDashboards' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#list_management_dashboards') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementDashboardCollection' ) end # rubocop:enable Metrics/BlockLength end
Gets the list of saved searches in a compartment with pagination. Returned properties are the summary. @param [String] compartment_id The ID of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :display_name A filter to return only resources that match the entire display name given. @option opts [String] :opc_request_id The client request ID for tracing. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @option opts [String] :page The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call. @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. (default to ASC) @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is the default.
(default to timeCreated) Allowed values are: timeCreated, displayName
@return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementSavedSearchCollection ManagementSavedSearchCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/list_management_saved_searches.rb.html) to see an example of how to use list_management_saved_searches
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 841 def list_management_saved_searches(compartment_id, opts = {}) logger.debug 'Calling operation DashxApisClient#list_management_saved_searches.' if logger raise "Missing the required parameter 'compartment_id' when calling list_management_saved_searches." if compartment_id.nil? if opts[:sort_order] && !OCI::ManagementDashboard::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::ManagementDashboard::Models::SORT_ORDERS_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/managementSavedSearches' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#list_management_saved_searches') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementSavedSearchCollection' ) end # rubocop:enable Metrics/BlockLength end
@return [Logger] The logger for this client. May be nil.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 93 def logger @api_client.config.logger end
Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 83 def region=(new_region) @region = new_region raise 'A region must be specified.' unless @region @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://managementdashboard.{region}.oci.{secondLevelDomain}') + '/20200901' logger.info "DashxApisClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Updates an existing dashboard identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20.
@param [String] management_dashboard_id A unique dashboard identifier. @param [OCI::ManagementDashboard::Models::UpdateManagementDashboardDetails] update_management_dashboard_details JSON metadata for changed dashboard properties. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementDashboard ManagementDashboard} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/update_management_dashboard.rb.html) to see an example of how to use update_management_dashboard
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 922 def update_management_dashboard(management_dashboard_id, update_management_dashboard_details, opts = {}) logger.debug 'Calling operation DashxApisClient#update_management_dashboard.' if logger raise "Missing the required parameter 'management_dashboard_id' when calling update_management_dashboard." if management_dashboard_id.nil? raise "Missing the required parameter 'update_management_dashboard_details' when calling update_management_dashboard." if update_management_dashboard_details.nil? raise "Parameter value for 'management_dashboard_id' must not be blank" if OCI::Internal::Util.blank_string?(management_dashboard_id) path = '/managementDashboards/{managementDashboardId}'.sub('{managementDashboardId}', management_dashboard_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_management_dashboard_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#update_management_dashboard') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementDashboard' ) end # rubocop:enable Metrics/BlockLength end
Updates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API.
@param [String] management_saved_search_id A unique saved search identifier. @param [OCI::ManagementDashboard::Models::UpdateManagementSavedSearchDetails] update_management_saved_search_details JSON metadata for changed saved search properties. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match 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.
@option opts [String] :opc_retry_token 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 might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::ManagementDashboard::Models::ManagementSavedSearch ManagementSavedSearch} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/managementdashboard/update_management_saved_search.rb.html) to see an example of how to use update_management_saved_search
API.
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 994 def update_management_saved_search(management_saved_search_id, update_management_saved_search_details, opts = {}) logger.debug 'Calling operation DashxApisClient#update_management_saved_search.' if logger raise "Missing the required parameter 'management_saved_search_id' when calling update_management_saved_search." if management_saved_search_id.nil? raise "Missing the required parameter 'update_management_saved_search_details' when calling update_management_saved_search." if update_management_saved_search_details.nil? raise "Parameter value for 'management_saved_search_id' must not be blank" if OCI::Internal::Util.blank_string?(management_saved_search_id) path = '/managementSavedSearches/{managementSavedSearchId}'.sub('{managementSavedSearchId}', management_saved_search_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_management_saved_search_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DashxApisClient#update_management_saved_search') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::ManagementDashboard::Models::ManagementSavedSearch' ) end # rubocop:enable Metrics/BlockLength end
Private Instance Methods
rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines
# File lib/oci/management_dashboard/dashx_apis_client.rb, line 1041 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end