oci 2.14.0 → 2.15.0

data/lib/oci/usage_api/models/saved_custom_table.rb

@@ -7,11 +7,11 @@ require 'date'
 module OCI
   # The custom table for Cost Analysis UI rendering.
   class UsageApi::Models::SavedCustomTable
-    # **[Required]** the name of custom table.
+    # **[Required]** The name of the custom table.
     # @return [String]
     attr_accessor :display_name
 
-    # row groupBy key list.
+    # The row groupBy key list.
     # example:
     #   `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",
     #     \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",
@@ -20,7 +20,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :row_group_by
 
-    # column groupBy key list.
+    # The column groupBy key list.
     # example:
     #   `[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",
     #     \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",
@@ -29,8 +29,8 @@ module OCI
     # @return [Array<String>]
     attr_accessor :column_group_by
 
-    # GroupBy a specific tagKey. Provide tagNamespace and tagKey in tag object. Only support one tag in the list
-    # example:
+    # GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported.
+    # For example:
     #   `[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`
     #
     # @return [Array<OCI::UsageApi::Models::Tag>]
@@ -40,7 +40,7 @@ module OCI
     # @return [Float]
     attr_accessor :compartment_depth
 
-    # the version of custom table.
+    # The version of the custom table.
     # @return [Float]
     attr_accessor :version
 

data/lib/oci/usage_api/models/update_custom_table_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Details for updating custom table.
+  # Details for updating the custom table.
   class UsageApi::Models::UpdateCustomTableDetails
     # This attribute is required.
     # @return [OCI::UsageApi::Models::SavedCustomTable]

data/lib/oci/usage_api/models/update_query_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Details for the query to update reportQuery, costAnalysisUI and displayName.
+  # Details for the query to update reportQuery, costAnalysisUI, and displayName.
   class UsageApi::Models::UpdateQueryDetails
     # This attribute is required.
     # @return [OCI::UsageApi::Models::QueryDefinition]

data/lib/oci/usage_api/models/usage_summary.rb

@@ -115,7 +115,7 @@ module OCI
     # @return [String]
     attr_accessor :overage
 
-    # is forecasted data
+    # The forecasted data.
     # @return [BOOLEAN]
     attr_accessor :is_forecast
 

data/lib/oci/usage_api/usage_api.rb

@@ -16,7 +16,6 @@ require 'oci/usage_api/models/configuration_aggregation'
 require 'oci/usage_api/models/cost_analysis_ui'
 require 'oci/usage_api/models/create_custom_table_details'
 require 'oci/usage_api/models/create_query_details'
-require 'oci/usage_api/models/create_schedule_report_details'
 require 'oci/usage_api/models/custom_table'
 require 'oci/usage_api/models/custom_table_collection'
 require 'oci/usage_api/models/custom_table_summary'
@@ -30,14 +29,9 @@ require 'oci/usage_api/models/query_summary'
 require 'oci/usage_api/models/report_query'
 require 'oci/usage_api/models/request_summarized_usages_details'
 require 'oci/usage_api/models/saved_custom_table'
-require 'oci/usage_api/models/saved_schedule_report'
-require 'oci/usage_api/models/schedule_report'
-require 'oci/usage_api/models/schedule_report_collection'
-require 'oci/usage_api/models/schedule_report_summary'
 require 'oci/usage_api/models/tag'
 require 'oci/usage_api/models/update_custom_table_details'
 require 'oci/usage_api/models/update_query_details'
-require 'oci/usage_api/models/update_schedule_report_details'
 require 'oci/usage_api/models/usage_aggregation'
 require 'oci/usage_api/models/usage_summary'
 

data/lib/oci/usage_api/usageapi_client.rb

@@ -98,9 +98,73 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Returns the created custom table.
+    #
+    # @param [OCI::UsageApi::Models::CreateCustomTableDetails] create_custom_table_details New custom table details.
+    # @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_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
+    #   particular request, please provide the request ID.
+    #
+    # @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.
+    #
+    # @return [Response] A Response object with data of type {OCI::UsageApi::Models::CustomTable CustomTable}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/usageapi/create_custom_table.rb.html) to see an example of how to use create_custom_table API.
+    def create_custom_table(create_custom_table_details, opts = {})
+      logger.debug 'Calling operation UsageapiClient#create_custom_table.' if logger
+
+      raise "Missing the required parameter 'create_custom_table_details' when calling create_custom_table." if create_custom_table_details.nil?
+
+      path = '/customTables'
+      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-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
+      # rubocop:enable Style/NegatedIf
+      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
+
+      post_body = @api_client.object_to_http_body(create_custom_table_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'UsageapiClient#create_custom_table') 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::UsageApi::Models::CustomTable'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Returns the created query.
     #
-    # @param [OCI::UsageApi::Models::CreateQueryDetails] create_query_details New query details. It is up to 10 saved query.
+    # @param [OCI::UsageApi::Models::CreateQueryDetails] create_query_details New query details. Up to ten saved queries.
     # @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
@@ -162,6 +226,69 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Delete a saved custom table by the OCID.
+    #
+    # @param [String] custom_table_id The custom table unique OCID.
+    # @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_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
+    #   particular request, please provide the request ID.
+    #
+    # @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.
+    #
+    # @return [Response] A Response object with data of type nil
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/usageapi/delete_custom_table.rb.html) to see an example of how to use delete_custom_table API.
+    def delete_custom_table(custom_table_id, opts = {})
+      logger.debug 'Calling operation UsageapiClient#delete_custom_table.' if logger
+
+      raise "Missing the required parameter 'custom_table_id' when calling delete_custom_table." if custom_table_id.nil?
+      raise "Parameter value for 'custom_table_id' must not be blank" if OCI::Internal::Util.blank_string?(custom_table_id)
+
+      path = '/customTables/{customTableId}'.sub('{customTableId}', custom_table_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-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = nil
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'UsageapiClient#delete_custom_table') 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
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Delete a saved query by the OCID.
     #
     # @param [String] query_id The query unique OCID.
@@ -225,6 +352,63 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Returns the saved custom table.
+    #
+    # @param [String] custom_table_id The custom table unique OCID.
+    # @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_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
+    #   particular request, please provide the request ID.
+    #
+    # @return [Response] A Response object with data of type {OCI::UsageApi::Models::CustomTable CustomTable}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/usageapi/get_custom_table.rb.html) to see an example of how to use get_custom_table API.
+    def get_custom_table(custom_table_id, opts = {})
+      logger.debug 'Calling operation UsageapiClient#get_custom_table.' if logger
+
+      raise "Missing the required parameter 'custom_table_id' when calling get_custom_table." if custom_table_id.nil?
+      raise "Parameter value for 'custom_table_id' must not be blank" if OCI::Internal::Util.blank_string?(custom_table_id)
+
+      path = '/customTables/{customTableId}'.sub('{customTableId}', custom_table_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-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: 'UsageapiClient#get_custom_table') 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::UsageApi::Models::CustomTable'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Returns the saved query.
     #
     # @param [String] query_id The query unique OCID.
@@ -282,6 +466,87 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Returns the saved custom table list.
+    #
+    # @param [String] compartment_id The compartment ID in which to list resources.
+    # @param [String] saved_report_id The saved report ID 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] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
+    #   particular request, please provide the request ID.
+    #
+    # @option opts [Integer] :limit The maximumimum number of items to return. (default to 25)
+    # @option opts [String] :page The page token representing the page at which to start retrieving results.
+    #   This is usually retrieved from a previous list call.
+    #
+    # @option opts [String] :sort_by The field to sort by. If not specified, the default is displayName.
+    #    (default to displayName)
+    #   Allowed values are: displayName
+    # @option opts [String] :sort_order The sort order to use, whether 'asc' or 'desc'. (default to ASC)
+    #   Allowed values are: ASC, DESC
+    # @return [Response] A Response object with data of type {OCI::UsageApi::Models::CustomTableCollection CustomTableCollection}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/usageapi/list_custom_tables.rb.html) to see an example of how to use list_custom_tables API.
+    def list_custom_tables(compartment_id, saved_report_id, opts = {})
+      logger.debug 'Calling operation UsageapiClient#list_custom_tables.' if logger
+
+      raise "Missing the required parameter 'compartment_id' when calling list_custom_tables." if compartment_id.nil?
+      raise "Missing the required parameter 'saved_report_id' when calling list_custom_tables." if saved_report_id.nil?
+
+      if opts[:sort_by] && !%w[displayName].include?(opts[:sort_by])
+        raise 'Invalid value for "sort_by", must be one of displayName.'
+      end
+
+      if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
+        raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
+      end
+
+      path = '/customTables'
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+      query_params[:compartmentId] = compartment_id
+      query_params[:savedReportId] = saved_report_id
+      query_params[:limit] = opts[:limit] if opts[:limit]
+      query_params[:page] = opts[:page] if opts[:page]
+      query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
+      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
+
+      # 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: 'UsageapiClient#list_custom_tables') 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::UsageApi::Models::CustomTableCollection'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Returns the saved query list.
     #
     # @param [String] compartment_id The compartment ID in which to list resources.
@@ -480,6 +745,72 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
+    # Update a saved custom table by table id.
+    #
+    # @param [OCI::UsageApi::Models::UpdateCustomTableDetails] update_custom_table_details The information to be updated.
+    # @param [String] custom_table_id The custom table unique OCID.
+    # @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_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
+    #   particular request, please provide the request ID.
+    #
+    # @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.
+    #
+    # @return [Response] A Response object with data of type {OCI::UsageApi::Models::CustomTable CustomTable}
+    # @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/usageapi/update_custom_table.rb.html) to see an example of how to use update_custom_table API.
+    def update_custom_table(update_custom_table_details, custom_table_id, opts = {})
+      logger.debug 'Calling operation UsageapiClient#update_custom_table.' if logger
+
+      raise "Missing the required parameter 'update_custom_table_details' when calling update_custom_table." if update_custom_table_details.nil?
+      raise "Missing the required parameter 'custom_table_id' when calling update_custom_table." if custom_table_id.nil?
+      raise "Parameter value for 'custom_table_id' must not be blank" if OCI::Internal::Util.blank_string?(custom_table_id)
+
+      path = '/customTables/{customTableId}'.sub('{customTableId}', custom_table_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-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = @api_client.object_to_http_body(update_custom_table_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'UsageapiClient#update_custom_table') 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::UsageApi::Models::CustomTable'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
     # Update a saved query by the OCID.
     #
     # @param [OCI::UsageApi::Models::UpdateQueryDetails] update_query_details The information to be updated.