oci 2.4.5 → 2.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2b92722ec1966e7dde1c815a6f17cc9ce02a78ae34c69e74915e3d196e2517c
-  data.tar.gz: 70ef65d3a37c9f629cbe2df847e1e7ccf0befd6677eb2c6c60be7325df052f38
+  metadata.gz: 9102d161d8cf5b8b9da3293c5c47b1aecd7c46b6590d83acd4daef1f4665b7f7
+  data.tar.gz: 6d274676398027806c4241bbdcb1cd89cfeb28b621975535d699ec29e8c71508
 SHA512:
-  metadata.gz: 7983dd94e186bfdf68ac94791f5f94cdfca632442385228ae344f8f7aeb078a2af779ab0629f33d99aad0d55015bb7579126d2c9fac95e791fe39bbb6c024265
-  data.tar.gz: ac8b2b4bd13f1beefd3c1a6aa1fae13609f50d6a3c4960716e0885e432d9e0cdaa0a1055ba35f5e77aa7f5f94fb428f3630e2ceba8ccd79f7eb2c82a57dd44aa
+  metadata.gz: e7dd89624fbc3871ea76946a3e670b06c287dade7d8b5d69395c1d007fa6af0f343d2879300f5952f3eba4b2629a8d904fad8c6fd5800af3f4d48a0fa36da8b8
+  data.tar.gz: b3871a0c43b16b8d32f629f4f182959d3c12749d4f4b678b8d09ce6da921f7813db5cf1e43e12e072711be7bcc61502019f836659a4e51a169528f6ee873d730

data/README.md

@@ -1,5 +1,5 @@
 # Oracle Cloud Infrastructure Ruby SDK
-**Version 2.4.5**
+**Version 2.4.6**
 
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
 
@@ -7,6 +7,7 @@ This topic describes how to install, configure, and use the Oracle Cloud Infrast
 
 The Ruby SDK supports the following services:
 
+* Announcements 
 * Audit
 * Container Engine
 * Core Services (which includes Networking, Compute, and Block Volume)

data/lib/oci.rb

@@ -30,6 +30,7 @@ require 'oci/object_storage/object_storage'
 require 'oci/object_storage/transfer/transfer'
 require 'oci/resource_search/resource_search'
 require 'oci/key_management/key_management'
+require 'oci/announcements_service/announcements_service'
 
 # Top level module for the Oracle Cloud Infrastructure SDK
 module OCI

data/lib/oci/announcements_service/announcement_client.rb

@@ -0,0 +1,368 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'uri'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A description of the AnnouncementsService API
+  class AnnouncementsService::AnnouncementClient
+    # Client used to make HTTP requests.
+    # @return [OCI::ApiClient]
+    attr_reader :api_client
+
+    # Fully qualified endpoint URL
+    # @return [String]
+    attr_reader :endpoint
+
+    # The default retry configuration to apply to all operations in this service client. 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
+    # @return [OCI::Retry::RetryConfig]
+    attr_reader :retry_config
+
+    # The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}.
+    # @return [String]
+    attr_reader :region
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Layout/EmptyLines
+
+
+    # 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.
+    #
+    # @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 [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
+    # @param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests
+    #   the details for the proxy can be provided in this parameter
+    # @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)
+      # 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
+      # pass it to this constructor.
+      #
+      # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
+      # so try and load the config from the default file.
+      config ||= OCI.config unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+
+      if signer.nil?
+        signer = OCI::Signer.new(
+          config.user,
+          config.fingerprint,
+          config.tenancy,
+          config.key_file,
+          pass_phrase: config.pass_phrase,
+          private_key_content: config.key_content
+        )
+      end
+
+      @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
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Layout/EmptyLines
+
+    # Set the region that will be used to determine the service endpoint.
+    # This will usually correspond to a value in {OCI::Regions::REGION_ENUM},
+    # but may be an arbitrary string.
+    def region=(new_region)
+      @region = new_region
+
+      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
+    end
+
+    # @return [Logger] The logger for this client. May be nil.
+    def logger
+      @api_client.config.logger
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
+    # Gets details about single `Announcement` object
+    #
+    # @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.
+    #
+    # @return [Response] A Response object with data of type {OCI::AnnouncementsService::Models::Announcement Announcement}
+    def get_announcement(announcement_id, opts = {})
+      logger.debug 'Calling operation AnnouncementClient#get_announcement.' if logger
+
+      raise "Missing the required parameter 'announcement_id' when calling get_announcement." if announcement_id.nil?
+      raise "Parameter value for 'announcement_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_id)
+
+      path = '/announcements/{announcementId}'.sub('{announcementId}', announcement_id.to_s)
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params[:accept] = 'application/json'
+      header_params[:'content-type'] = 'application/json'
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = nil
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementClient#get_announcement') do
+        @api_client.call_api(
+          :GET,
+          path,
+          endpoint,
+          header_params: header_params,
+          query_params: query_params,
+          operation_signing_strategy: operation_signing_strategy,
+          body: post_body,
+          return_type: 'OCI::AnnouncementsService::Models::Announcement'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
+    # Get user status of specified 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.
+    #
+    # @return [Response] A Response object with data of type {OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails AnnouncementUserStatusDetails}
+    def get_announcement_user_status(announcement_id, opts = {})
+      logger.debug 'Calling operation AnnouncementClient#get_announcement_user_status.' if logger
+
+      raise "Missing the required parameter 'announcement_id' when calling get_announcement_user_status." if announcement_id.nil?
+      raise "Parameter value for 'announcement_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_id)
+
+      path = '/announcements/{announcementId}/userStatus'.sub('{announcementId}', announcement_id.to_s)
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params[:accept] = 'application/json'
+      header_params[:'content-type'] = 'application/json'
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = nil
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementClient#get_announcement_user_status') do
+        @api_client.call_api(
+          :GET,
+          path,
+          endpoint,
+          header_params: header_params,
+          query_params: query_params,
+          operation_signing_strategy: operation_signing_strategy,
+          body: post_body,
+          return_type: 'OCI::AnnouncementsService::Models::AnnouncementUserStatusDetails'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
+    # Gets a list of `Announcement` objects for the current tenancy
+    #
+    # @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
+    #   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
+    #   Allowed values are: timeOneValue, timeTwoValue, timeCreated, referenceTicketNumber, summary, announcementType
+    # @option opts [String] :sort_order sort order
+    #   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.
+    #
+    # @return [Response] A Response object with data of type {OCI::AnnouncementsService::Models::AnnouncementsCollection AnnouncementsCollection}
+    def list_announcements(compartment_id, opts = {})
+      logger.debug 'Calling operation AnnouncementClient#list_announcements.' if logger
+
+      raise "Missing the required parameter 'compartment_id' when calling list_announcements." if compartment_id.nil?
+
+      if opts[:lifecycle_state] && !%w[ACTIVE INACTIVE].include?(opts[:lifecycle_state])
+        raise 'Invalid value for "lifecycle_state", must be one of ACTIVE, INACTIVE.'
+      end
+
+      if opts[:sort_by] && !%w[timeOneValue timeTwoValue timeCreated referenceTicketNumber summary announcementType].include?(opts[:sort_by])
+        raise 'Invalid value for "sort_by", must be one of timeOneValue, timeTwoValue, timeCreated, referenceTicketNumber, summary, announcementType.'
+      end
+
+      if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
+        raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
+      end
+
+      path = '/announcements'
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+      query_params[:compartmentId] = compartment_id
+      query_params[:limit] = opts[:limit] if opts[:limit]
+      query_params[:page] = opts[:page] if opts[:page]
+      query_params[:announcementType] = opts[:announcement_type] if opts[:announcement_type]
+      query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
+      query_params[:isBanner] = opts[:is_banner] if !opts[:is_banner].nil?
+      query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
+      query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
+      query_params[:timeOneEarliestTime] = opts[:time_one_earliest_time] if opts[:time_one_earliest_time]
+      query_params[:timeOneLatestTime] = opts[:time_one_latest_time] if opts[:time_one_latest_time]
+
+      # Header Params
+      header_params = {}
+      header_params[:accept] = 'application/json'
+      header_params[:'content-type'] = 'application/json'
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = nil
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementClient#list_announcements') do
+        @api_client.call_api(
+          :GET,
+          path,
+          endpoint,
+          header_params: header_params,
+          query_params: query_params,
+          operation_signing_strategy: operation_signing_strategy,
+          body: post_body,
+          return_type: 'OCI::AnnouncementsService::Models::AnnouncementsCollection'
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
+
+
+    # Update `Announcement` status with whether user has seen or supressed the announcement
+    #
+    # @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 [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.
+    #
+    # @return [Response] A Response object with data of type nil
+    def update_announcement_user_status(announcement_id, status_details, opts = {})
+      logger.debug 'Calling operation AnnouncementClient#update_announcement_user_status.' if logger
+
+      raise "Missing the required parameter 'announcement_id' when calling update_announcement_user_status." if announcement_id.nil?
+      raise "Missing the required parameter 'status_details' when calling update_announcement_user_status." if status_details.nil?
+      raise "Parameter value for 'announcement_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_id)
+
+      path = '/announcements/{announcementId}/userStatus'.sub('{announcementId}', announcement_id.to_s)
+      operation_signing_strategy = :standard
+
+      # rubocop:disable Style/NegatedIf
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params[:accept] = 'application/json'
+      header_params[:'content-type'] = 'application/json'
+      header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
+      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
+      # rubocop:enable Style/NegatedIf
+
+      post_body = @api_client.object_to_http_body(status_details)
+
+      # rubocop:disable Metrics/BlockLength
+      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementClient#update_announcement_user_status') do
+        @api_client.call_api(
+          :PUT,
+          path,
+          endpoint,
+          header_params: header_params,
+          query_params: query_params,
+          operation_signing_strategy: operation_signing_strategy,
+          body: post_body
+        )
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines
+
+    private
+
+    def applicable_retry_config(opts = {})
+      return @retry_config unless opts.key?(:retry_config)
+
+      opts[:retry_config]
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/announcements_service/announcement_client_composite_operations.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # This class provides a wrapper around {OCI::AnnouncementsService::AnnouncementClient} and offers convenience methods
+  # for operations that would otherwise need to be chained together. For example, instead of performing an action
+  # on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource
+  # to enter a given state, you can call a single method in this class to accomplish the same functionality
+  class AnnouncementsService::AnnouncementClientCompositeOperations
+    # The {OCI::AnnouncementsService::AnnouncementClient} used to communicate with the service_client
+    #
+    # @return [OCI::AnnouncementsService::AnnouncementClient]
+    attr_reader :service_client
+
+    # Initializes a new AnnouncementClientCompositeOperations
+    #
+    # @param [OCI::AnnouncementsService::AnnouncementClient] service_client The client used to communicate with the service.
+    #   Defaults to a new service client created via {OCI::AnnouncementsService::AnnouncementClient#initialize} with no arguments
+    def initialize(service_client = OCI::AnnouncementsService::AnnouncementClient.new)
+      @service_client = service_client
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/announcements_service/announcements_service.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+module OCI
+  module AnnouncementsService
+    # Module containing models for requests made to, and responses received from,
+    # OCI AnnouncementsService services
+    module Models
+    end
+  end
+end
+
+# Require models
+require 'oci/announcements_service/models/affected_resource'
+require 'oci/announcements_service/models/announcement'
+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'
+
+# Require service utilities
+require 'oci/announcements_service/util'