oci 2.10.0 → 2.11.0

data/lib/oci/management_dashboard/models/create_management_saved_search_details.rb

@@ -14,55 +14,55 @@ module OCI
       TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD = 'WIDGET_DONT_SHOW_IN_DASHBOARD'.freeze
     ].freeze
 
-    # **[Required]** id for saved search.  Must be provided if OOB, otherwise must not be provided.
+    # ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search.
     # @return [String]
     attr_accessor :id
 
-    # **[Required]** Display name for saved search.
+    # **[Required]** Display name of the saved search.
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** Id for application (LA, APM, etc.) that owners this saved search.  Each owner has a unique Id.
+    # **[Required]** ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
     # @return [String]
     attr_accessor :provider_id
 
-    # **[Required]** Version.
+    # **[Required]** Version of the service that owns this saved search.
     # @return [String]
     attr_accessor :provider_version
 
-    # **[Required]** Name for application (LA, APM, etc.) that owners this saved search.
+    # **[Required]** Name of the service (for example, Logging Analytics) that owns the saved search.
     # @return [String]
     attr_accessor :provider_name
 
-    # **[Required]** The ocid of the compartment that owns the saved search.
+    # **[Required]** OCID of the compartment in which the saved search resides.
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** String boolean (\"true\" or \"false\") to indicate Out Of the Box saved search.
+    # **[Required]** Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
     # @return [BOOLEAN]
     attr_accessor :is_oob_saved_search
 
-    # **[Required]** Description.
+    # **[Required]** Description of the saved search.
     # @return [String]
     attr_accessor :description
 
-    # **[Required]** Json for internationalization.
+    # **[Required]** JSON that contains internationalization options.
     # @return [Object]
     attr_accessor :nls
 
-    # **[Required]** How to show the saved search.
+    # **[Required]** Determines how the saved search is displayed in a dashboard.
     # @return [String]
     attr_reader :type
 
-    # **[Required]** Json to contain options for UI.
+    # **[Required]** JSON that contains user interface options.
     # @return [Object]
     attr_accessor :ui_config
 
-    # **[Required]** Array of Json to contain options for source of data.
+    # **[Required]** Array of JSON that contain data source options.
     # @return [Array<Object>]
     attr_accessor :data_config
 
-    # **[Required]** Screenshot.
+    # **[Required]** Screen image of the saved search.
     # @return [String]
     attr_accessor :screen_image
 
@@ -70,11 +70,11 @@ module OCI
     # @return [String]
     attr_accessor :metadata_version
 
-    # **[Required]** Template.
+    # **[Required]** Reference to the HTML file of the widget.
     # @return [String]
     attr_accessor :widget_template
 
-    # **[Required]** View Model
+    # **[Required]** Reference to the view model of the widget.
     # @return [String]
     attr_accessor :widget_vm
 

data/lib/oci/management_dashboard/models/management_dashboard.rb

@@ -5,61 +5,61 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Properties for a dashboard, including dashboard id.
+  # Properties of a dashboard, including dashboard ID.
   class ManagementDashboard::Models::ManagementDashboard
-    # **[Required]** Dashboard Id. Must be providied if OOB, otherwise must not be provided.
+    # **[Required]** ID of the dashboard.
     # @return [String]
     attr_accessor :dashboard_id
 
-    # **[Required]** Provider Id.
+    # **[Required]** ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
     # @return [String]
     attr_accessor :provider_id
 
-    # **[Required]** Provider name.
+    # **[Required]** Name of the service (for example, Logging Analytics) that owns the dashboard.
     # @return [String]
     attr_accessor :provider_name
 
-    # **[Required]** Provider version.
+    # **[Required]** Version of the service that owns the dashboard.
     # @return [String]
     attr_accessor :provider_version
 
-    # **[Required]** Dashboard tiles array
+    # **[Required]** Array of dashboard tiles.
     # @return [Array<OCI::ManagementDashboard::Models::ManagementDashboardTileDetails>]
     attr_accessor :tiles
 
-    # **[Required]** Display name for dashboard.
+    # **[Required]** Display name of the dashboard.
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** Dashboard's description.
+    # **[Required]** Description of the dashboard.
     # @return [String]
     attr_accessor :description
 
-    # **[Required]** The ocid of the compartment that owns the dashboard.
+    # **[Required]** OCID of the compartment in which the dashboard resides.
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** String boolean (\"true\" or \"false\"). OOB (Out of the Box) dashboards are only provided by Oracle.  They cannot be modified by non-Oracle.
+    # **[Required]** Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
     # @return [BOOLEAN]
     attr_accessor :is_oob_dashboard
 
-    # **[Required]** String boolean (\"true\" or \"false\").  When false, dashboard is not shown in dashboard home.
+    # **[Required]** Determines whether the dashboard will be displayed in Dashboard Home.
     # @return [BOOLEAN]
     attr_accessor :is_show_in_home
 
-    # **[Required]** Created by which user.
+    # **[Required]** User who created the dashboard.
     # @return [String]
     attr_accessor :created_by
 
-    # **[Required]** Time created.
+    # **[Required]** Date and time the dashboard was created.
     # @return [DateTime]
     attr_accessor :time_created
 
-    # **[Required]** Updated by which user.
+    # **[Required]** User who updated the dashboard.
     # @return [String]
     attr_accessor :updated_by
 
-    # **[Required]** Time updated.
+    # **[Required]** Date and time the dashboard was updated.
     # @return [DateTime]
     attr_accessor :time_updated
 
@@ -67,35 +67,35 @@ module OCI
     # @return [String]
     attr_accessor :metadata_version
 
-    # **[Required]** String boolean (\"true\" or \"false\").  When false, dashboard is not automatically refreshed in intervals.
+    # **[Required]** Determines whether the description of the dashboard is displayed.
     # @return [BOOLEAN]
     attr_accessor :is_show_description
 
-    # **[Required]** screen image.
+    # **[Required]** Screen image of the dashboard.
     # @return [String]
     attr_accessor :screen_image
 
-    # **[Required]** Json for internationalization.
+    # **[Required]** JSON that contains internationalization options.
     # @return [Object]
     attr_accessor :nls
 
-    # **[Required]** Json to contain options for UI.
+    # **[Required]** JSON that contains user interface options.
     # @return [Object]
     attr_accessor :ui_config
 
-    # **[Required]** Array of Json to contain options for source of data.
+    # **[Required]** Array of JSON that contain data source options.
     # @return [Array<Object>]
     attr_accessor :data_config
 
-    # **[Required]** NORMAL means single dashboard, SET means dashboard set.
+    # **[Required]** Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
     # @return [String]
     attr_accessor :type
 
-    # **[Required]** String boolean (\"true\" or \"false\").
+    # **[Required]** Determines whether the dashboard is set as favorite.
     # @return [BOOLEAN]
     attr_accessor :is_favorite
 
-    # **[Required]** Array of saved searches.
+    # **[Required]** Array of saved searches in the dashboard.
     # @return [Array<OCI::ManagementDashboard::Models::ManagementSavedSearch>]
     attr_accessor :saved_searches
 

data/lib/oci/management_dashboard/models/management_dashboard_export_details.rb

@@ -7,7 +7,7 @@ require 'date'
 module OCI
   # Array of dashboards to export.  Response from export must be directly acceptable to import (compartmentIds may have to be changed).
   class ManagementDashboard::Models::ManagementDashboardExportDetails
-    # **[Required]** Array of dashboards
+    # **[Required]** Array of dashboards.
     # @return [Array<OCI::ManagementDashboard::Models::ManagementDashboardForImportExportDetails>]
     attr_accessor :dashboards
 

data/lib/oci/management_dashboard/models/management_dashboard_for_import_export_details.rb

@@ -5,45 +5,45 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Properties for a dashboard, including dashboard id, and saved searches, for import purposes.
+  # Properties of a dashboard, including dashboard ID and saved searches, for import purposes.
   class ManagementDashboard::Models::ManagementDashboardForImportExportDetails
-    # **[Required]** Dashboard Id. Must be providied if OOB, otherwise must not be provided.
+    # **[Required]** ID of the dashboard.
     # @return [String]
     attr_accessor :dashboard_id
 
-    # **[Required]** Provider Id.
+    # **[Required]** ID of the service (for example log-analytics) that owns the dashboard. Each service has a unique ID.
     # @return [String]
     attr_accessor :provider_id
 
-    # **[Required]** Provider name.
+    # **[Required]** Name of the service (for example, Logging Analytics) that owns the dashboard.
     # @return [String]
     attr_accessor :provider_name
 
-    # **[Required]** Provider version.
+    # **[Required]** Version of the service that owns the dashboard.
     # @return [String]
     attr_accessor :provider_version
 
-    # **[Required]** Dashboard tiles array
+    # **[Required]** Array of dashboard tiles.
     # @return [Array<OCI::ManagementDashboard::Models::ManagementDashboardTileDetails>]
     attr_accessor :tiles
 
-    # **[Required]** Display name for dashboard.
+    # **[Required]** Display name of the dashboard.
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** Dashboard's description.
+    # **[Required]** Description of the dashboard.
     # @return [String]
     attr_accessor :description
 
-    # **[Required]** The ocid of the compartment that owns the dashboard.
+    # **[Required]** OCID of the compartment in which the dashboard resides.
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** String boolean (\"true\" or \"false\"). OOB (Out of the Box) dashboards are only provided by Oracle.  They cannot be modified by non-Oracle.
+    # **[Required]** Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
     # @return [BOOLEAN]
     attr_accessor :is_oob_dashboard
 
-    # **[Required]** String boolean (\"true\" or \"false\").  When false, dashboard is not shown in dashboard home.
+    # **[Required]** Determines whether the dashboard will be displayed in Dashboard Home.
     # @return [BOOLEAN]
     attr_accessor :is_show_in_home
 
@@ -51,35 +51,35 @@ module OCI
     # @return [String]
     attr_accessor :metadata_version
 
-    # **[Required]** String boolean (\"true\" or \"false\").  When false, dashboard is not automatically refreshed in intervals.
+    # **[Required]** Determines whether the description of the dashboard is displayed.
     # @return [BOOLEAN]
     attr_accessor :is_show_description
 
-    # **[Required]** screen image.
+    # **[Required]** Screen image of the dashboard.
     # @return [String]
     attr_accessor :screen_image
 
-    # **[Required]** Json for internationalization.
+    # **[Required]** JSON that contains internationalization options.
     # @return [Object]
     attr_accessor :nls
 
-    # **[Required]** Json to contain options for UI.
+    # **[Required]** JSON that contains user interface options.
     # @return [Object]
     attr_accessor :ui_config
 
-    # **[Required]** Array of Json to contain options for source of data.
+    # **[Required]** Array of JSON that contain data source options.
     # @return [Array<Object>]
     attr_accessor :data_config
 
-    # **[Required]** NORMAL means single dashboard, SET means dashboard set.
+    # **[Required]** Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
     # @return [String]
     attr_accessor :type
 
-    # **[Required]** String boolean (\"true\" or \"false\").
+    # **[Required]** Determines whether the dashboard is set as favorite.
     # @return [BOOLEAN]
     attr_accessor :is_favorite
 
-    # **[Required]** Array of saved searches.
+    # **[Required]** Array of saved searches in the dashboard.
     # @return [Array<OCI::ManagementDashboard::Models::ManagementSavedSearchForImportDetails>]
     attr_accessor :saved_searches
 

data/lib/oci/management_dashboard/models/management_dashboard_import_details.rb

@@ -7,7 +7,7 @@ require 'date'
 module OCI
   # Array of dashboards to import.
   class ManagementDashboard::Models::ManagementDashboardImportDetails
-    # **[Required]** Array of dashboards
+    # **[Required]** Array of dashboards.
     # @return [Array<OCI::ManagementDashboard::Models::ManagementDashboardForImportExportDetails>]
     attr_accessor :dashboards
 

data/lib/oci/management_dashboard/models/management_dashboard_summary.rb

@@ -6,46 +6,46 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Summary of properties for a dashboard.
+  # Summary of the properties of a dashboard.
   class ManagementDashboard::Models::ManagementDashboardSummary
     LIFECYCLE_STATE_ENUM = [
       LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
       LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** Dashboard Id. Must be providied if OOB, otherwise must not be provided.
+    # **[Required]** ID of the dashboard.
     # @return [String]
     attr_accessor :dashboard_id
 
-    # **[Required]** Display name for dashboard.
+    # **[Required]** Display name of the dashboard.
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** Dashboard's description.
+    # **[Required]** Description of the dashboard.
     # @return [String]
     attr_accessor :description
 
-    # **[Required]** The ocid of the compartment that owns the dashboard.
+    # **[Required]** OCID of the compartment in which the dashboard resides.
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** String boolean (\"true\" or \"false\").  OOB (Out of the Box) dashboards are only provided by Oracle.  They cannot be modified by non-Oracle.
+    # **[Required]** Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
     # @return [BOOLEAN]
     attr_accessor :is_oob_dashboard
 
-    # **[Required]** Created by which user.
+    # **[Required]** User who created the dashboard.
     # @return [String]
     attr_accessor :created_by
 
-    # **[Required]** Time created.
+    # **[Required]** Date and time the dashboard was created.
     # @return [DateTime]
     attr_accessor :time_created
 
-    # **[Required]** Updated by which user.
+    # **[Required]** User who updated the dashboard.
     # @return [String]
     attr_accessor :updated_by
 
-    # **[Required]** Time updated.
+    # **[Required]** Date and time the dashboard was updated.
     # @return [DateTime]
     attr_accessor :time_updated
 
@@ -53,19 +53,19 @@ module OCI
     # @return [String]
     attr_accessor :metadata_version
 
-    # **[Required]** screen image.
+    # **[Required]** Screen image of the dashboard.
     # @return [String]
     attr_accessor :screen_image
 
-    # **[Required]** Json for internationalization.
+    # **[Required]** JSON that contains internationalization options.
     # @return [Object]
     attr_accessor :nls
 
-    # **[Required]** NORMAL means single dashboard, SET means dashboard set.
+    # **[Required]** Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
     # @return [String]
     attr_accessor :type
 
-    # **[Required]** State of dashboard.
+    # **[Required]** Current lifecycle state of the dashboard.
     # @return [String]
     attr_reader :lifecycle_state
 

data/lib/oci/management_dashboard/models/management_dashboard_tile_details.rb

@@ -6,7 +6,9 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Properties of dashboard tile representing a saved search.
+  # Properties of the dashboard tile representing a saved search.
+  # Tiles are laid out in a twelve column grid system with (0,0) at upper left corner.
+  #
   class ManagementDashboard::Models::ManagementDashboardTileDetails
     STATE_ENUM = [
       STATE_DELETED = 'DELETED'.freeze,
@@ -15,47 +17,47 @@ module OCI
       STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** Display name for saved search.
+    # **[Required]** Display name of the saved search.
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** Id of saved search.
+    # **[Required]** ID of the saved search.
     # @return [String]
     attr_accessor :saved_search_id
 
-    # **[Required]** Row, Y position
+    # **[Required]** Tile's row number.
     # @return [Integer]
     attr_accessor :row
 
-    # **[Required]** Column, X position
+    # **[Required]** Tile's column number.
     # @return [Integer]
     attr_accessor :column
 
-    # **[Required]** Height position
+    # **[Required]** The number of rows the tile occupies.
     # @return [Integer]
     attr_accessor :height
 
-    # **[Required]** Width position
+    # **[Required]** The number of columns the tile occupies.
     # @return [Integer]
     attr_accessor :width
 
-    # **[Required]** Json for internationalization.
+    # **[Required]** JSON that contains internationalization options.
     # @return [Object]
     attr_accessor :nls
 
-    # **[Required]** Json to contain options for UI.
+    # **[Required]** JSON that contains user interface options.
     # @return [Object]
     attr_accessor :ui_config
 
-    # **[Required]** Array of Json to contain options for source of data.
+    # **[Required]** Array of JSON that contain data source options.
     # @return [Array<Object>]
     attr_accessor :data_config
 
-    # **[Required]** State of saved search.
+    # **[Required]** Current state of the saved search.
     # @return [String]
     attr_reader :state
 
-    # **[Required]** Drill down configuration
+    # **[Required]** Drill-down configuration to define the destination of a drill-down action.
     # @return [Object]
     attr_accessor :drilldown_config