RubyGems - oci - Versions diffs - 2.10.0 → 2.11.0 - Mend

oci 2.10.0 → 2.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (611) hide show

data/lib/oci/logging/models/log_saved_search_summary_collection.rb CHANGED

@@ -5,7 +5,7 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # A collection of LogSavedSearchSummary items
+  # A collection of LogSavedSearchSummary items.
   #
   class Logging::Models::LogSavedSearchSummaryCollection
     # **[Required]** The Saved Seach Summaries

data/lib/oci/logging/models/log_summary.rb CHANGED

@@ -32,7 +32,7 @@ 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]
@@ -42,11 +42,11 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_enabled
-    # **[Required]** The state of an pipeline.
+    # **[Required]** The pipeline state.
     # @return [String]
     attr_reader :lifecycle_state
-    # **[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
@@ -76,7 +76,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/parameter.rb CHANGED

@@ -6,7 +6,7 @@ require 'logger'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Parameters that a category of resource supports.
+  # Parameters that a resource category supports.
   class Logging::Models::Parameter
     TYPE_ENUM = [
       TYPE_INTEGER = 'integer'.freeze,
@@ -23,7 +23,7 @@ module OCI
     # @return [String]
     attr_reader :type
-    # Java regex pattern to validate parameter value.
+    # Java regex pattern to validate a parameter value.
     # @return [String]
     attr_accessor :pattern

data/lib/oci/logging/models/resource_type.rb CHANGED

@@ -5,13 +5,13 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Type of Resource that Service provides.
+  # Type of resource that a service provides.
   class Logging::Models::ResourceType
     # Resource type name.
     # @return [String]
     attr_accessor :name
-    # categories for resources.
+    # Categories for resources.
     # @return [Array<OCI::Logging::Models::Category>]
     attr_accessor :categories

data/lib/oci/logging/models/service_summary.rb CHANGED

@@ -5,17 +5,17 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Summary of Services that are integrated with public logging
+  # Summary of services that are integrated with public logging.
   class Logging::Models::ServiceSummary
     # **[Required]** Tenant OCID.
     # @return [String]
     attr_accessor :tenant_id
-    # Apollo project namespace if any.
+    # Apollo project namespace, if any.
     # @return [String]
     attr_accessor :namespace
-    # **[Required]** Service id as set in Service Principal.
+    # **[Required]** Service ID as set in Service Principal.
     # @return [String]
     attr_accessor :service_principal_name
@@ -23,15 +23,15 @@ module OCI
     # @return [String]
     attr_accessor :endpoint
-    # **[Required]** User friendly service name.
+    # **[Required]** User-friendly service name.
     # @return [String]
     attr_accessor :name
-    # Service id.
+    # Service ID.
     # @return [String]
     attr_accessor :id
-    # **[Required]** Type of Resource that a Service provides.
+    # **[Required]** Type of resource that a service provides.
     # @return [Array<OCI::Logging::Models::ResourceType>]
     attr_accessor :resource_types

data/lib/oci/logging/models/source.rb CHANGED

@@ -14,7 +14,7 @@ module OCI
       SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
-    # **[Required]** The source of the log.
+    # **[Required]** The log source.
     # * **OCISERVICE:** Oracle Service.
     #
     # @return [String]

data/lib/oci/logging/models/unified_agent_apache2_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # apache 2 log parser
+  # Apache 2 log parser.
   class Logging::Models::UnifiedAgentApache2Parser < Logging::Models::UnifiedAgentParser
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/oci/logging/models/unified_agent_apache_error_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # apache error log parser
+  # Apache error log parser.
   class Logging::Models::UnifiedAgentApacheErrorParser < Logging::Models::UnifiedAgentParser
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/oci/logging/models/unified_agent_configuration.rb CHANGED

@@ -32,7 +32,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]
@@ -65,7 +65,7 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_last_modified
-    # **[Required]** The state of an pipeline.
+    # **[Required]** The pipeline state.
     # @return [String]
     attr_reader :lifecycle_state

data/lib/oci/logging/models/unified_agent_configuration_collection.rb CHANGED

@@ -5,7 +5,7 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Results of a UnifiedAgentConfiguration search. Contains UnifiedAgentConfigurationSummary items
+  # Results of a UnifiedAgentConfiguration search. Contains UnifiedAgentConfigurationSummary items.
   class Logging::Models::UnifiedAgentConfigurationCollection
     # **[Required]** List of UnifiedAgentConfigurationSummary.
     # @return [Array<OCI::Logging::Models::UnifiedAgentConfigurationSummary>]

data/lib/oci/logging/models/unified_agent_configuration_summary.rb CHANGED

@@ -6,7 +6,7 @@ require 'logger'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Unified Agent configuration summary object returned by list API.
+  # Unified Agent configuration summary object returned by the list API.
   class Logging::Models::UnifiedAgentConfigurationSummary
     LIFECYCLE_STATE_ENUM = [
       LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
@@ -37,7 +37,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]
@@ -70,7 +70,7 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_last_modified
-    # **[Required]** The state of an pipeline.
+    # **[Required]** The pipeline state.
     # @return [String]
     attr_reader :lifecycle_state
@@ -78,7 +78,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_enabled
-    # **[Required]** Type of unified agent service configuration.
+    # **[Required]** Type of Unified Agent service configuration.
     # @return [String]
     attr_reader :configuration_type

data/lib/oci/logging/models/unified_agent_csv_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # CSV Parser
+  # CSV Parser.
   class Logging::Models::UnifiedAgentCsvParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :delimiter

data/lib/oci/logging/models/unified_agent_grok_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # grok parser
+  # grok parser.
   class Logging::Models::UnifiedAgentGrokParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :grok_name_key

data/lib/oci/logging/models/unified_agent_logging_destination.rb CHANGED

@@ -5,7 +5,7 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # logging destination object.
+  # Logging destination object.
   class Logging::Models::UnifiedAgentLoggingDestination
     # **[Required]** The OCID of the resource.
     # @return [String]

data/lib/oci/logging/models/unified_agent_logging_source.rb CHANGED

@@ -6,7 +6,7 @@ require 'logger'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # logging source object.
+  # Logging source object.
   # This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
   class Logging::Models::UnifiedAgentLoggingSource
     SOURCE_TYPE_ENUM = [
@@ -19,7 +19,7 @@ module OCI
     # @return [String]
     attr_accessor :name
-    # **[Required]** unified schema logging source Type
+    # **[Required]** Unified schema logging source type.
     # @return [String]
     attr_reader :source_type

data/lib/oci/logging/models/unified_agent_multiline_grok_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # multiline grok parser
+  # Multiline grok parser.
   class Logging::Models::UnifiedAgentMultilineGrokParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :grok_name_key

data/lib/oci/logging/models/unified_agent_multiline_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # multiline parser
+  # Multiline parser.
   class Logging::Models::UnifiedAgentMultilineParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :format_firstline

data/lib/oci/logging/models/unified_agent_none_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # this parser signifies a non parser and puts entire log line in a message_key.
+  # This parser signifies a non-parser, and puts the entire log line in a message_key.
   class Logging::Models::UnifiedAgentNoneParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :message_key

data/lib/oci/logging/models/unified_agent_parser.rb CHANGED

@@ -26,27 +26,27 @@ module OCI
       PARSER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
-    # **[Required]** type of fluent parser.
+    # **[Required]** Type of fluent parser.
     # @return [String]
     attr_reader :parser_type
-    # Specify time field for event time. If the event doesn't have this field, current time is used.
+    # Specify 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
-    # Specify types for converting field into other type.
+    # Specify types for converting a field into another type.
     # @return [Hash<String, String>]
     attr_accessor :types
-    # Specify null value pattern
+    # Specify the null value pattern.
     # @return [String]
     attr_accessor :null_value_pattern
-    # If true, empty string field is replaced with nil
+    # If true, an empty string field is replaced with nil.
     # @return [BOOLEAN]
     attr_accessor :is_null_empty_string
-    # If true, use Fluent::EventTime.now(current time) as a timestamp when time_key is specified
+    # If true, use Fluent::EventTime.now(current time) as a timestamp when time_key is specified.
     # @return [BOOLEAN]
     attr_accessor :is_estimate_current_event
@@ -54,7 +54,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_keep_time_key
-    # Specify timeout for parse processing. This is mainly for detecting wrong regexp pattern.
+    # Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern.
     # @return [Integer]
     attr_accessor :timeout_in_milliseconds

data/lib/oci/logging/models/unified_agent_regex_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # regexp parser
+  # regexp parser.
   class Logging::Models::UnifiedAgentRegexParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :expression

data/lib/oci/logging/models/unified_agent_service_configuration_details.rb CHANGED

@@ -14,7 +14,7 @@ module OCI
       CONFIGURATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
-    # **[Required]** Type of unified agent service configuration.
+    # **[Required]** Type of Unified Agent service configuration.
     # @return [String]
     attr_reader :configuration_type

data/lib/oci/logging/models/unified_agent_syslog_parser.rb CHANGED

@@ -7,7 +7,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Syslog Parser
+  # Syslog Parser.
   class Logging::Models::UnifiedAgentSyslogParser < Logging::Models::UnifiedAgentParser
     MESSAGE_FORMAT_ENUM = [
       MESSAGE_FORMAT_RFC3164 = 'RFC3164'.freeze,

data/lib/oci/logging/models/unified_agent_tail_log_source.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_logging_source'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # tail log source object.
+  # Tail log source object.
   class Logging::Models::UnifiedAgentTailLogSource < Logging::Models::UnifiedAgentLoggingSource
     # @return [Array<String>]
     attr_accessor :paths

data/lib/oci/logging/models/unified_agent_tsv_parser.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # TSV Parser
+  # TSV Parser.
   class Logging::Models::UnifiedAgentTsvParser < Logging::Models::UnifiedAgentParser
     # @return [String]
     attr_accessor :delimiter

data/lib/oci/logging/models/unified_agent_windows_event_source.rb CHANGED

@@ -6,7 +6,7 @@ require_relative 'unified_agent_logging_source'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # windows events log source object.
+  # Windows events log source object.
   class Logging::Models::UnifiedAgentWindowsEventSource < Logging::Models::UnifiedAgentLoggingSource
     # @return [Array<String>]
     attr_accessor :channels

data/lib/oci/logging/models/unified_json_parser.rb CHANGED

@@ -7,7 +7,7 @@ require_relative 'unified_agent_parser'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # json parser.
+  # JSON parser.
   class Logging::Models::UnifiedJSONParser < Logging::Models::UnifiedAgentParser
     TIME_TYPE_ENUM = [
       TIME_TYPE_FLOAT = 'FLOAT'.freeze,

data/lib/oci/logging/models/update_configuration_details.rb CHANGED

@@ -5,7 +5,7 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # The updateable configuration properties
+  # The updatable configuration properties.
   class Logging::Models::UpdateConfigurationDetails
     # This attribute is required.
     # @return [OCI::Logging::Models::SourceUpdateDetails]

data/lib/oci/logging/models/update_log_details.rb CHANGED

@@ -5,9 +5,9 @@ require 'date'
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Update Log Object properties
+  # Update log object properties.
   class Logging::Models::UpdateLogDetails
-    # 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]
@@ -32,7 +32,7 @@ module OCI
     # @return [Hash<String, String>]
     attr_accessor :freeform_tags
-    # 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/update_log_group_details.rb CHANGED

@@ -7,7 +7,7 @@ require 'date'
 module OCI
   # The details to update a log group.
   class Logging::Models::UpdateLogGroupDetails
-    # 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/update_log_saved_search_details.rb CHANGED

@@ -8,7 +8,7 @@ module OCI
   # The update details to update a log saved search.
   #
   class Logging::Models::UpdateLogSavedSearchDetails
-    # 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]
@@ -23,10 +23,6 @@ module OCI
     # @return [String]
     attr_accessor :query
-    # 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).
     #
@@ -49,7 +45,6 @@ module OCI
         'name': :'name',
         'description': :'description',
         'query': :'query',
-        'is_quick_start': :'isQuickStart',
         'defined_tags': :'definedTags',
         'freeform_tags': :'freeformTags'
         # rubocop:enable Style/SymbolLiteral
@@ -63,7 +58,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
@@ -79,7 +73,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 = {})
@@ -94,12 +87,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')
@@ -127,7 +114,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
@@ -145,7 +131,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, description, query, is_quick_start, defined_tags, freeform_tags].hash
+      [name, description, query, defined_tags, freeform_tags].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines