oci 2.4.7 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8636927b21dc67d2ae17488d1ec9c596173f22d2f948ec53cd05f729afa6ba6f
-  data.tar.gz: 47feb57d3901f8c676f3aca869b6999458958915ef9b8aeca1a08810cdfd7cee
+  metadata.gz: bf6aff98d6f342152483db6ce35a1bfb4027282bcf917c4107516061cb7f5251
+  data.tar.gz: fefda2f66264fd6b8f70783b89ec7fcd8cba808b8295f336c6a43af508e067d6
 SHA512:
-  metadata.gz: e42a878254106a66b9fceadb34cf66d108fae2188f50d8ecda3f6763d9855419d4b0232e9cb870a8b6504a38d500d7149febac88f5d723c584b2d5d2c4e843c2
-  data.tar.gz: 637fb65574d6bc7fe79d9d0d31088f389ae312a4d9cc50ab54948544eb77d5dcc686e0d1aa9aa75e5929b4b3afd4627c707eddaaee3d167081726c63cb128aca
+  metadata.gz: 4ca16c082548a1d88944371c5f7de08df026fb398920272a86a30d68e4b97945088245527b631aa3d0f731190ee42a1f1976e561618d83db3c1d4c46d82514d3
+  data.tar.gz: c31bba2b0656027fe0e184e3dae745a0db44d39b318720c24779b72b4834659e9a01cc99956d3e3651d0628629cd04a364821bacae64c676d8930b499ec9001e

data/README.md

@@ -1,5 +1,5 @@
 # Oracle Cloud Infrastructure Ruby SDK
-**Version 2.4.7**
+**Version 2.5.0**
 
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
 
@@ -21,6 +21,7 @@ The Ruby SDK supports the following services:
 * Load Balancing
 * Object Storage
 * Search
+* Streaming
 * Web Application Acceleration and Security
 
 **Licensing:** This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License.
@@ -167,6 +168,22 @@ Note that the Ruby SDK does not support parsing custom attributes in the configu
 
 Some response fields are enum-typed. In the future, individual services may return values not covered by existing enums for that field. To address this possibility, every enum-type response field has an additional value named "UNKNOWN_ENUM_VALUE". If a service returns a value that is not recognized by your version of the SDK, then the response field will be set to this value. Please ensure that your code handles the "UNKNOWN_ENUM_VALUE" case if you have conditional logic based on an enum-typed field.
 
+## New Region Support
+
+If you are using a version of the SDK released prior to the announcement of a new region, you may still be able to reach it, depending on whether the region is in the oraclecloud.com realm.
+
+A *region* is a localized geographic area. For more information on regions and how to identify them, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm).
+
+A *realm* is a set of regions that share entities. You can identify your realm by looking at the domain name at the end of the network address. For example, the realm for ``xyz.abc.123.oraclecloud.com`` is ``oraclecloud.com``.
+
+### oraclecloud.com Realm
+
+For regions in the oraclecloud.com realm, even if the `OCI::Regions::REGION_ENUM` does not contain the new region, the forward compatibility of the SDK can automatically handle it. You can pass new region names just as you would pass ones that are already defined. For more information on passing region names in the configuration, see [Configuring the SDK](#configuring-the-sdk). For details on `OCI::Regions::REGION_ENUM`, see [OCI::Regions](https://docs.cloud.oracle.com/iaas/tools/ruby/latest/OCI/Regions.html).
+
+### Other Realms
+
+Accessing regions in realms other than oraclecloud.com with prior versions of the Ruby SDK is currently unsupported. We recommend moving to a version that explicitly supports the desired region.
+
 ## Writing Your First Ruby Program with the SDK
 
     require 'oci'

data/lib/oci.rb

@@ -33,6 +33,7 @@ require 'oci/key_management/key_management'
 require 'oci/announcements_service/announcements_service'
 require 'oci/waas/waas'
 require 'oci/healthchecks/healthchecks'
+require 'oci/streaming/streaming'
 
 # Top level module for the Oracle Cloud Infrastructure SDK
 module OCI

data/lib/oci/announcements_service/announcement_client.rb

@@ -5,7 +5,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # A description of the AnnouncementsService API
+  # Manage Oracle Cloud Infrastructure console announcements.
   class AnnouncementsService::AnnouncementClient
     # Client used to make HTTP requests.
     # @return [OCI::ApiClient]
@@ -25,20 +25,22 @@ module OCI
     # @return [String]
     attr_reader :region
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Layout/EmptyLines
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Layout/EmptyLines, Metrics/PerceivedComplexity
 
 
     # Creates a new AnnouncementClient.
     # Notes:
     #   If a config is not specified, then the global OCI.config will be used.
-    #   This client is not thread-safe
     #
-    #   A region must be specified in either the config or the region parameter. If specified in both,
-    #   then the region parameter 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
@@ -47,7 +49,7 @@ module OCI
     # @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
-    def initialize(config: nil, region: nil, signer: nil, proxy_settings: nil, retry_config: nil)
+    def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
       # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals)
       # 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
@@ -73,11 +75,16 @@ module OCI
       @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
       @retry_config = retry_config
 
-      region ||= config.region
-      region ||= signer.region if signer.respond_to?(:region)
-      self.region = region
+      if endpoint
+        @endpoint = endpoint + '/20180904'
+      else
+        region ||= config.region
+        region ||= signer.region if signer.respond_to?(:region)
+        self.region = region
+      end
+      logger.info "AnnouncementClient endpoint set to '#{@endpoint}'." if logger
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Layout/EmptyLines
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Layout/EmptyLines, Metrics/PerceivedComplexity
 
     # Set the region that will be used to determine the service endpoint.
     # This will usually correspond to a value in {OCI::Regions::REGION_ENUM},
@@ -88,7 +95,7 @@ module OCI
       raise 'A region must be specified.' unless @region
 
       @endpoint = OCI::Regions.get_service_endpoint(@region, :AnnouncementClient) + '/20180904'
-      logger.info "AnnouncementClient endpoint set to '#{endpoint}'." if logger
+      logger.info "AnnouncementClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
     end
 
     # @return [Logger] The logger for this client. May be nil.
@@ -101,14 +108,14 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Gets details about single `Announcement` object
+    # Gets the details of a specific announcement.
     #
-    # @param [String] announcement_id The OCID of the announcement
+    # @param [String] announcement_id The OCID of the announcement.
     # @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_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
+    #   a particular request, please provide the complete request ID.
     #
     # @return [Response] A Response object with data of type {OCI::AnnouncementsService::Models::Announcement Announcement}
     def get_announcement(announcement_id, opts = {})
@@ -157,14 +164,14 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Get user status of specified announcement
+    # Gets information about whether a specific announcement was acknowledged by a user.
     #
-    # @param [String] announcement_id The OCID of the announcement
+    # @param [String] announcement_id The OCID of the announcement.
     # @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_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
+    #   a particular request, please provide the complete request ID.
     #
     # @return [Response] A Response object with data of type {OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails AnnouncementUserStatusDetails}
     def get_announcement_user_status(announcement_id, opts = {})
@@ -213,26 +220,30 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Gets a list of `Announcement` objects for the current tenancy
+    # Gets a list of announcements for the current tenancy.
+    #
+    # @param [String] compartment_id The OCID of the compartment. Because announcements are specific to a tenancy, this is the
+    #   OCID of the root compartment.
     #
-    # @param [String] compartment_id OCID of the compartment where search is performed. Announcements are specific to tenancy, so this should an ID of the root compartment
     # @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 [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
     # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
-    # @option opts [String] :announcement_type Type of the announcements to show
-    # @option opts [String] :lifecycle_state Filters returned announcements basing on whether they are active now
+    # @option opts [String] :announcement_type The type of announcement.
+    # @option opts [String] :lifecycle_state The announcement's current lifecycle state.
     #   Allowed values are: ACTIVE, INACTIVE
-    # @option opts [BOOLEAN] :is_banner Filters returned announcements basing on whether they should be shown as a banner
-    # @option opts [String] :sort_by announcements sort order
+    # @option opts [BOOLEAN] :is_banner Whether the announcement is displayed as a console banner.
+    # @option opts [String] :sort_by The criteria to sort by. You can specify only one sort order.
+    #
     #   Allowed values are: timeOneValue, timeTwoValue, timeCreated, referenceTicketNumber, summary, announcementType
-    # @option opts [String] :sort_order sort order
+    # @option opts [String] :sort_order The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)
+    #
     #   Allowed values are: ASC, DESC
-    # @option opts [DateTime] :time_one_earliest_time The earliest timeOneValue to include
-    # @option opts [DateTime] :time_one_latest_time The latest timeOneValue to include
-    # @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 [DateTime] :time_one_earliest_time The boundary for the earliest `timeOneValue` date on announcements that you want to see.
+    # @option opts [DateTime] :time_one_latest_time The boundary for the latest `timeOneValue` date on announcements that you want to see.
+    # @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
+    #   a particular request, please provide the complete request ID.
     #
     # @return [Response] A Response object with data of type {OCI::AnnouncementsService::Models::AnnouncementsCollection AnnouncementsCollection}
     def list_announcements(compartment_id, opts = {})
@@ -302,16 +313,16 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Update `Announcement` status with whether user has seen or supressed the announcement
+    # Updates the status of the specified announcement with regard to whether it has been marked as read.
     #
-    # @param [String] announcement_id The OCID of the announcement
-    # @param [OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails] status_details Object for updating a user's status of announcement.
+    # @param [String] announcement_id The OCID of the announcement.
+    # @param [OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails] status_details The information to use to update the announcement's read status.
     # @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 Optimistic locking version
-    # @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 The locking version, used for optimistic concurrency control.
+    # @option opts [String] :opc_request_id The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
+    #   a particular request, please provide the complete request ID.
     #
     # @return [Response] A Response object with data of type nil
     def update_announcement_user_status(announcement_id, status_details, opts = {})

data/lib/oci/announcements_service/announcements_service.rb

@@ -16,7 +16,6 @@ require 'oci/announcements_service/models/announcement_summary'
 require 'oci/announcements_service/models/announcement_user_status_details'
 require 'oci/announcements_service/models/announcements_collection'
 require 'oci/announcements_service/models/base_announcement'
-require 'oci/announcements_service/models/notification_followup_details'
 
 # Require generated clients
 require 'oci/announcements_service/announcement_client'

data/lib/oci/announcements_service/models/affected_resource.rb

@@ -4,18 +4,18 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
-  # Descrption of a resource affected by the announcement
+  # The resource affected by the event described in the announcement.
   #
   class AnnouncementsService::Models::AffectedResource # rubocop:disable Metrics/LineLength
-    # **[Required]** The OCID of the resource
+    # **[Required]** The OCID of the affected resource.
     # @return [String]
     attr_accessor :resource_id
 
-    # **[Required]** User-friendly name of the resource
+    # **[Required]** The friendly name of the resource.
     # @return [String]
     attr_accessor :resource_name
 
-    # **[Required]** Region where this resource belongs to
+    # **[Required]** The region where the affected resource exists.
     # @return [String]
     attr_accessor :region
 

data/lib/oci/announcements_service/models/announcement.rb

@@ -6,21 +6,23 @@ require_relative 'base_announcement'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
-  # An announcement object which represents a message targetted to a specific tenant
+  # A message about an impactful operational event.
   #
   class AnnouncementsService::Models::Announcement < AnnouncementsService::Models::BaseAnnouncement # rubocop:disable Metrics/LineLength
-    # A more detailed explanation of the notification. A markdown format input
+    # A detailed explanation of the event, expressed by using Markdown language. Avoid entering
+    # confidential information.
+    #
     # @return [String]
     attr_accessor :description
 
-    # A markdown format input that forms e.g. the FAQ section of a notification
+    # Additional information about the event, expressed by using Markdown language and included in the
+    # details view of an announcement. Additional information might include remediation steps or
+    # answers to frequently asked questions. Avoid entering confidential information.
+    #
     # @return [String]
     attr_accessor :additional_information
 
-    # @return [Array<OCI::AnnouncementsService::Models::NotificationFollowupDetails>]
-    attr_accessor :followups
-
-    # List of resources (possibly empty) affected by this announcement
+    # The list of resources, if any, affected by the event described in the announcement.
     # @return [Array<OCI::AnnouncementsService::Models::AffectedResource>]
     attr_accessor :affected_resources
 
@@ -45,7 +47,6 @@ module OCI
         'time_updated': :'timeUpdated',
         'description': :'description',
         'additional_information': :'additionalInformation',
-        'followups': :'followups',
         'affected_resources': :'affectedResources'
         # rubocop:enable Style/SymbolLiteral
       }
@@ -72,7 +73,6 @@ module OCI
         'time_updated': :'DateTime',
         'description': :'String',
         'additional_information': :'String',
-        'followups': :'Array<OCI::AnnouncementsService::Models::NotificationFollowupDetails>',
         'affected_resources': :'Array<OCI::AnnouncementsService::Models::AffectedResource>'
         # rubocop:enable Style/SymbolLiteral
       }
@@ -100,7 +100,6 @@ module OCI
     # @option attributes [DateTime] :time_updated The value to assign to the {OCI::AnnouncementsService::Models::BaseAnnouncement#time_updated #time_updated} proprety
     # @option attributes [String] :description The value to assign to the {#description} property
     # @option attributes [String] :additional_information The value to assign to the {#additional_information} property
-    # @option attributes [Array<OCI::AnnouncementsService::Models::NotificationFollowupDetails>] :followups The value to assign to the {#followups} property
     # @option attributes [Array<OCI::AnnouncementsService::Models::AffectedResource>] :affected_resources The value to assign to the {#affected_resources} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
@@ -120,8 +119,6 @@ module OCI
 
       self.additional_information = attributes[:'additional_information'] if attributes[:'additional_information']
 
-      self.followups = attributes[:'followups'] if attributes[:'followups']
-
       self.affected_resources = attributes[:'affectedResources'] if attributes[:'affectedResources']
 
       raise 'You cannot provide both :affectedResources and :affected_resources' if attributes.key?(:'affectedResources') && attributes.key?(:'affected_resources')
@@ -157,7 +154,6 @@ module OCI
         time_updated == other.time_updated &&
         description == other.description &&
         additional_information == other.additional_information &&
-        followups == other.followups &&
         affected_resources == other.affected_resources
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/LineLength, Layout/EmptyLines
@@ -174,7 +170,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, type, reference_ticket_number, summary, time_one_title, time_one_value, time_two_title, time_two_value, services, affected_regions, announcement_type, lifecycle_state, is_banner, time_created, time_updated, description, additional_information, followups, affected_resources].hash
+      [id, type, reference_ticket_number, summary, time_one_title, time_one_value, time_two_title, time_two_value, services, affected_regions, announcement_type, lifecycle_state, is_banner, time_created, time_updated, description, additional_information, affected_resources].hash
     end
     # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
 

data/lib/oci/announcements_service/models/announcement_summary.rb

@@ -6,7 +6,7 @@ require_relative 'base_announcement'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
-  # An announcement summary object which is returned by List API
+  # Summary representation of an announcement.
   #
   class AnnouncementsService::Models::AnnouncementSummary < AnnouncementsService::Models::BaseAnnouncement # rubocop:disable Metrics/LineLength
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/oci/announcements_service/models/announcement_user_status_details.rb

@@ -4,19 +4,19 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
-  # An announcement status
+  # An announcement's status regarding whether it has been acknowledged by a user.
   #
   class AnnouncementsService::Models::AnnouncementUserStatusDetails # rubocop:disable Metrics/LineLength
-    # **[Required]** The OCID of the announcement this status belongs to
+    # **[Required]** The OCID of the announcement that this status is associated with.
     # @return [String]
     attr_accessor :user_status_announcement_id
 
-    # **[Required]** The OCID of the user this status belongs to
+    # **[Required]** The OCID of the user that this status is associated with.
     # @return [String]
     attr_accessor :user_id
 
-    # The date and time the announcement was acknowledged, in the format defined by RFC3339
-    # Example: `2016-07-22T17:43:01.389+0000`
+    # The date and time the announcement was acknowledged, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
+    # Example: `2019-01-01T17:43:01.389+0000`
     #
     # @return [DateTime]
     attr_accessor :time_acknowledged

data/lib/oci/announcements_service/models/announcements_collection.rb

@@ -4,14 +4,14 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
-  # Results of annoucements search. Contains both announcements, and user specific status of the announcments
+  # A list of announcements that match filter criteria, if any. Results contain both the announcements and the user-specific status of the announcements.
   #
   class AnnouncementsService::Models::AnnouncementsCollection # rubocop:disable Metrics/LineLength
-    # collection of announcements
+    # A collection of announcements.
     # @return [Array<OCI::AnnouncementsService::Models::AnnouncementSummary>]
     attr_accessor :items
 
-    # user specific status of found announcements
+    # The user-specific status for found announcements.
     # @return [Array<OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails>]
     attr_accessor :user_statuses
 

data/lib/oci/announcements_service/models/base_announcement.rb

@@ -4,7 +4,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
-  # Base for announcements and incidents
+  # Incident information that forms the basis of an announcement. Avoid entering confidential information.
   # 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 AnnouncementsService::Models::BaseAnnouncement # rubocop:disable Metrics/LineLength
     ANNOUNCEMENT_TYPE_ENUM = [
@@ -29,66 +29,76 @@ module OCI
       LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze
     ].freeze
 
-    # **[Required]** The OCID of the announcement
+    # **[Required]** The OCID of the announcement.
     # @return [String]
     attr_accessor :id
 
-    # **[Required]** Entity type
+    # **[Required]** The entity type.
     # @return [String]
     attr_accessor :type
 
-    # **[Required]** The reference JIRA ticket number
+    # **[Required]** The reference Jira ticket number.
     # @return [String]
     attr_accessor :reference_ticket_number
 
-    # **[Required]** Forms part of the email subject and/or the console representation (a banner or alike)
+    # **[Required]** A summary of the issue. A summary might appear in the console banner view of the announcement or in
+    # an email subject line. Avoid entering confidential information.
+    #
     # @return [String]
     attr_accessor :summary
 
-    # The title of the first time value, e.g. Time Started
+    # The label associated with an initial time value.
+    # Example: `Time Started`
+    #
     # @return [String]
     attr_accessor :time_one_title
 
-    # The first time value, actual meaning depending on notification type
+    # The actual value of the first time value for the event. Typically, this is the time an event started, but the meaning
+    # can vary, depending on the announcement type.
+    #
     # @return [DateTime]
     attr_accessor :time_one_value
 
-    # The title of the second time value, e.g. Time Ended
+    # The label associated with a second time value.
+    # Example: `Time Ended`
+    #
     # @return [String]
     attr_accessor :time_two_title
 
-    # The second time value, actual meaning depending on notification type
+    # The actual value of the second time value. Typically, this is the time an event ended, but the meaning
+    # can vary, depending on the announcement type.
+    #
     # @return [DateTime]
     attr_accessor :time_two_value
 
-    # Impacted services
+    # **[Required]** Impacted Oracle Cloud Infrastructure services.
     # @return [Array<String>]
     attr_accessor :services
 
-    # Impacted regions
+    # **[Required]** Impacted regions.
     # @return [Array<String>]
     attr_accessor :affected_regions
 
-    # **[Required]** The detailed description of an announcement
+    # **[Required]** The type of announcement. An announcement's type signals its severity.
     # @return [String]
     attr_reader :announcement_type
 
-    # **[Required]** Lifecycle states of announcement
+    # **[Required]** The current lifecycle state of the announcement.
     # @return [String]
     attr_reader :lifecycle_state
 
-    # **[Required]** Show announcement as a banner
+    # **[Required]** Whether the announcement is displayed as a banner in the console.
     # @return [BOOLEAN]
     attr_accessor :is_banner
 
-    # The date and time the announcement was created, in the format defined by RFC3339
-    # Example: `2016-07-22T17:43:01.389+0000`
+    # The date and time the announcement was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
+    # Example: `2019-01-01T17:43:01.389+0000`
     #
     # @return [DateTime]
     attr_accessor :time_created
 
-    # The date and time the announcement was last updated, in the format defined by RFC3339
-    # Example: `2016-07-22T17:43:01.389+0000`
+    # The date and time the announcement was last updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
+    # Example: `2019-01-01T17:43:01.389+0000`
     #
     # @return [DateTime]
     attr_accessor :time_updated