oci 2.10.0 → 2.11.0

data/lib/oci/logging/logging_management_client_composite_operations.rb

@@ -129,8 +129,8 @@ module OCI
     # Calls {OCI::Logging::LoggingManagementClient#change_unified_agent_configuration_compartment} and then waits for the {OCI::Logging::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] unified_agent_configuration_id The OCID of the unified agent configuration.
-    # @param [OCI::Logging::Models::ChangeUnifiedAgentConfigurationCompartmentDetails] change_unified_agent_configuration_compartment_details Request to change the compartment of a given resource
+    # @param [String] unified_agent_configuration_id The OCID of the Unified Agent configuration.
+    # @param [OCI::Logging::Models::ChangeUnifiedAgentConfigurationCompartmentDetails] change_unified_agent_configuration_compartment_details Request to change the compartment of a given resource.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#change_unified_agent_configuration_compartment}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -180,7 +180,7 @@ module OCI
     # to enter the given state(s).
     #
     # @param [String] log_group_id OCID of a log group to work with.
-    # @param [OCI::Logging::Models::CreateLogDetails] create_log_details Log object config details.
+    # @param [OCI::Logging::Models::CreateLogDetails] create_log_details Log object configuration details.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#create_log}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -275,10 +275,49 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::Logging::LoggingManagementClient#create_log_saved_search} and then waits for the {OCI::Logging::Models::LogSavedSearch} acted upon
+    # to enter the given state(s).
+    #
+    # @param [OCI::Logging::Models::CreateLogSavedSearchDetails] create_log_saved_search_details Specification of the Saved Search to create
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::LogSavedSearch#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#create_log_saved_search}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type {OCI::Logging::Models::LogSavedSearch}
+    def create_log_saved_search_and_wait_for_state(create_log_saved_search_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_log_saved_search(create_log_saved_search_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_log_saved_search(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::Logging::LoggingManagementClient#create_unified_agent_configuration} and then waits for the {OCI::Logging::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [OCI::Logging::Models::CreateUnifiedAgentConfigurationDetails] create_unified_agent_configuration_details Unified Agent configuration creation object.
+    # @param [OCI::Logging::Models::CreateUnifiedAgentConfigurationDetails] create_unified_agent_configuration_details Unified agent configuration creation object.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#create_unified_agent_configuration}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -423,10 +462,51 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::Logging::LoggingManagementClient#delete_log_saved_search} and then waits for the {OCI::Logging::Models::LogSavedSearch} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] log_saved_search_id OCID of the logSavedSearch
+    #
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::LogSavedSearch#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#delete_log_saved_search}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type nil
+    def delete_log_saved_search_and_wait_for_state(log_saved_search_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      initial_get_result = @service_client.get_log_saved_search(log_saved_search_id)
+      operation_result = @service_client.delete_log_saved_search(log_saved_search_id, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+
+      begin
+        waiter_result = initial_get_result.wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200,
+          succeed_on_not_found: true
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::Logging::LoggingManagementClient#delete_unified_agent_configuration} and then waits for the {OCI::Logging::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] unified_agent_configuration_id The OCID of the unified agent configuration.
+    # @param [String] unified_agent_configuration_id The OCID of the Unified Agent configuration.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#delete_unified_agent_configuration}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -475,7 +555,7 @@ module OCI
     # Calls {OCI::Logging::LoggingManagementClient#delete_work_request} and then waits for the {OCI::Logging::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] work_request_id The ID of the asynchronous request.
+    # @param [String] work_request_id The asynchronous request ID.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#delete_work_request}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -622,10 +702,51 @@ module OCI
     # rubocop:disable Layout/EmptyLines
 
 
+    # Calls {OCI::Logging::LoggingManagementClient#update_log_saved_search} and then waits for the {OCI::Logging::Models::LogSavedSearch} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] log_saved_search_id OCID of the logSavedSearch
+    #
+    # @param [OCI::Logging::Models::UpdateLogSavedSearchDetails] update_log_saved_search_details Updates to the saved search.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::LogSavedSearch#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Logging::LoggingManagementClient#update_log_saved_search}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type {OCI::Logging::Models::LogSavedSearch}
+    def update_log_saved_search_and_wait_for_state(log_saved_search_id, update_log_saved_search_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.update_log_saved_search(log_saved_search_id, update_log_saved_search_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_log_saved_search(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
     # Calls {OCI::Logging::LoggingManagementClient#update_unified_agent_configuration} and then waits for the {OCI::Logging::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] unified_agent_configuration_id The OCID of the unified agent configuration.
+    # @param [String] unified_agent_configuration_id The OCID of the Unified Agent configuration.
     # @param [OCI::Logging::Models::UpdateUnifiedAgentConfigurationDetails] update_unified_agent_configuration_details Unified agent configuration to update. Empty group associations list doesn't modify the list, null value for group association clears all the previous associations.
     #
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Logging::Models::WorkRequest#status}

data/lib/oci/logging/models/category.rb

@@ -5,17 +5,17 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # categories for resources.
+  # Categories for resources.
   class Logging::Models::Category
-    # Category name
+    # Category name.
     # @return [String]
     attr_accessor :name
 
-    # Category display name
+    # Category display name.
     # @return [String]
     attr_accessor :display_name
 
-    # Parameters category supports.
+    # Parameters the category supports.
     # @return [Array<OCI::Logging::Models::Parameter>]
     attr_accessor :parameters
 

data/lib/oci/logging/models/change_log_group_compartment_details.rb

@@ -5,9 +5,9 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Contains details indicating which compartment the resource should move to
+  # Contains details indicating which compartment the resource should move to.
   class Logging::Models::ChangeLogGroupCompartmentDetails
-    # The of the compartment into which the resource should be moved.
+    # The compartment into which the resource should be moved.
     # @return [String]
     attr_accessor :compartment_id
 

data/lib/oci/logging/models/change_log_log_group_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Contains details indicating which log group the log should move to
+  # Contains details indicating which log group the log should move to.
   class Logging::Models::ChangeLogLogGroupDetails
     # Log group OCID.
     # @return [String]

data/lib/oci/logging/models/change_unified_agent_configuration_compartment_details.rb

@@ -5,9 +5,9 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Contains details indicating which compartment the resource should move to
+  # Contains details indicating which compartment the resource should move to.
   class Logging::Models::ChangeUnifiedAgentConfigurationCompartmentDetails
-    # The ocid the compartment into which the resource should be moved.
+    # The OCID the compartment into which the resource should be moved.
     # @return [String]
     attr_accessor :compartment_id
 

data/lib/oci/logging/models/create_log_details.rb

@@ -12,13 +12,13 @@ module OCI
       LOG_TYPE_SERVICE = 'SERVICE'.freeze
     ].freeze
 
-    # **[Required]** The display name of a user-friendly name. It has to be unique within enclosing resource,
+    # **[Required]** The user-friendly display name. This must be unique within the enclosing resource,
     # and it's changeable. Avoid entering confidential information.
     #
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** The logType that the log object is for, custom or service.
+    # **[Required]** The logType that the log object is for, whether custom or service.
     # @return [String]
     attr_reader :log_type
 
@@ -44,7 +44,7 @@ module OCI
     # @return [OCI::Logging::Models::Configuration]
     attr_accessor :configuration
 
-    # Log retention duration in days.
+    # Log retention duration in 30-day increments (30, 60, 90 and so on).
     # @return [Integer]
     attr_accessor :retention_duration
 

data/lib/oci/logging/models/create_log_group_details.rb

@@ -11,7 +11,7 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** The display name of a user-friendly name. It has to be unique within enclosing resource,
+    # **[Required]** The user-friendly display name. This must be unique within the enclosing resource,
     # and it's changeable. Avoid entering confidential information.
     #
     # @return [String]

data/lib/oci/logging/models/create_log_saved_search_details.rb

@@ -12,7 +12,7 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** The display name of a user-friendly name. It has to be unique within enclosing resource,
+    # **[Required]** The user-friendly display name. This must be unique within the enclosing resource,
     # and it's changeable. Avoid entering confidential information.
     #
     # @return [String]
@@ -27,10 +27,6 @@ module OCI
     # @return [String]
     attr_accessor :query
 
-    # **[Required]** True if the LogSavedSearch should be show as quickstart in the UI
-    # @return [BOOLEAN]
-    attr_accessor :is_quick_start
-
     # Defined tags for this resource. Each key is predefined and scoped to a
     # namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
     #
@@ -54,7 +50,6 @@ module OCI
         'name': :'name',
         'description': :'description',
         'query': :'query',
-        'is_quick_start': :'isQuickStart',
         'defined_tags': :'definedTags',
         'freeform_tags': :'freeformTags'
         # rubocop:enable Style/SymbolLiteral
@@ -69,7 +64,6 @@ module OCI
         'name': :'String',
         'description': :'String',
         'query': :'String',
-        'is_quick_start': :'BOOLEAN',
         'defined_tags': :'Hash<String, Hash<String, Object>>',
         'freeform_tags': :'Hash<String, String>'
         # rubocop:enable Style/SymbolLiteral
@@ -86,7 +80,6 @@ module OCI
     # @option attributes [String] :name The value to assign to the {#name} property
     # @option attributes [String] :description The value to assign to the {#description} property
     # @option attributes [String] :query The value to assign to the {#query} property
-    # @option attributes [BOOLEAN] :is_quick_start The value to assign to the {#is_quick_start} property
     # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
     def initialize(attributes = {})
@@ -107,12 +100,6 @@ module OCI
 
       self.query = attributes[:'query'] if attributes[:'query']
 
-      self.is_quick_start = attributes[:'isQuickStart'] unless attributes[:'isQuickStart'].nil?
-
-      raise 'You cannot provide both :isQuickStart and :is_quick_start' if attributes.key?(:'isQuickStart') && attributes.key?(:'is_quick_start')
-
-      self.is_quick_start = attributes[:'is_quick_start'] unless attributes[:'is_quick_start'].nil?
-
       self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']
 
       raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')
@@ -141,7 +128,6 @@ module OCI
         name == other.name &&
         description == other.description &&
         query == other.query &&
-        is_quick_start == other.is_quick_start &&
         defined_tags == other.defined_tags &&
         freeform_tags == other.freeform_tags
     end
@@ -159,7 +145,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [compartment_id, name, description, query, is_quick_start, defined_tags, freeform_tags].hash
+      [compartment_id, name, description, query, defined_tags, freeform_tags].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/logging/models/create_unified_agent_configuration_details.rb

@@ -7,7 +7,7 @@ require 'date'
 module OCI
   # Unified Agent configuration creation object.
   class Logging::Models::CreateUnifiedAgentConfigurationDetails
-    # The display name of a user-friendly name. It has to be unique within enclosing resource,
+    # The user-friendly display name. This must be unique within the enclosing resource,
     # and it's changeable. Avoid entering confidential information.
     #
     # @return [String]

data/lib/oci/logging/models/grok_pattern.rb

@@ -5,25 +5,25 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # grok pattern object
+  # grok pattern object.
   class Logging::Models::GrokPattern
-    # **[Required]** The grok pattern
+    # **[Required]** The grok pattern.
     # @return [String]
     attr_accessor :pattern
 
-    # The name key to tag this grok pattern
+    # The name key to tag this grok pattern.
     # @return [String]
     attr_accessor :name
 
-    # Specify time field for event time. If the event doesn't have this field, current time is used.
+    # Specify the time field for the event time. If the event doesn't have this field, the current time is used.
     # @return [String]
     attr_accessor :field_time_key
 
-    # Process value using specified format. This is available only when time_type is string.
+    # Process value using the specified format. This is available only when time_type is a string.
     # @return [String]
     attr_accessor :field_time_format
 
-    # Use specified timezone. One can parse/format the time value in the specified timezone.
+    # Use the specified time zone. The time value can be parsed or formatted in the specified time zone.
     # @return [String]
     attr_accessor :field_time_zone
 

data/lib/oci/logging/models/log.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Represents a Log object
+  # Represents a log object.
   class Logging::Models::Log
     LOG_TYPE_ENUM = [
       LOG_TYPE_CUSTOM = 'CUSTOM'.freeze,
@@ -36,13 +36,13 @@ module OCI
     # @return [String]
     attr_accessor :log_group_id
 
-    # **[Required]** The display name of a user-friendly name. It has to be unique within enclosing resource,
+    # **[Required]** The user-friendly display name. This must be unique within the enclosing resource,
     # and it's changeable. Avoid entering confidential information.
     #
     # @return [String]
     attr_accessor :display_name
 
-    # **[Required]** The logType that the log object is for, custom or service.
+    # **[Required]** The logType that the log object is for, whether custom or service.
     # @return [String]
     attr_reader :log_type
 
@@ -68,7 +68,7 @@ module OCI
     # @return [OCI::Logging::Models::Configuration]
     attr_accessor :configuration
 
-    # **[Required]** The state of an pipeline.
+    # **[Required]** The pipeline state.
     # @return [String]
     attr_reader :lifecycle_state
 
@@ -80,7 +80,7 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_last_modified
 
-    # Log retention duration in days.
+    # Log retention duration in 30-day increments (30, 60, 90 and so on).
     # @return [Integer]
     attr_accessor :retention_duration
 

data/lib/oci/logging/models/log_group.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Represents a LogGroup object
+  # Represents a LogGroup object.
   class Logging::Models::LogGroup
     LIFECYCLE_STATE_ENUM = [
       LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
@@ -26,7 +26,7 @@ module OCI
     # @return [String]
     attr_accessor :compartment_id
 
-    # **[Required]** The display name of a user-friendly name. It has to be unique within enclosing resource,
+    # **[Required]** The user-friendly display name. This must be unique within the enclosing resource,
     # and it's changeable. Avoid entering confidential information.
     #
     # @return [String]
@@ -36,7 +36,7 @@ module OCI
     # @return [String]
     attr_accessor :description
 
-    # The state of the log group object.
+    # The log group object state.
     # @return [String]
     attr_reader :lifecycle_state