oci 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dce598b5266d9674ebe6ea0e70e422671331b47
-  data.tar.gz: e8dd3e1ad2d99f2ea990f4b93878692d02a3aa32
+  metadata.gz: 0a647e50ba728b350d47a6c070345cab43ececd7
+  data.tar.gz: 52c6e26ab685616101aad910a6ba8273e55fb851
 SHA512:
-  metadata.gz: b50db7913ddcb46fd07972392ddee5ef2fe8d9faa3e84f56411d25151c32163661f169b8beb1502676c14da5a415cb8afdc2e1bcda7f25ac12e60c5b6029d106
-  data.tar.gz: 2969c2b133de7b2d9563f5293386f282f4a38de21d1d47cdeef4a2045096d3cabcc392c6965413f7d655d127dc1be9ec62f162ba6fdae1fad187d7720b344086
+  metadata.gz: 9a580cf9ce0e7fff8a812eec68673d978f36b54dd49d2b8912e1fc142811d0bd2d7e83154e7608d2ee930aed9db088116d398f2f442b0f65436a1084ea2fbf28
+  data.tar.gz: 9080bd2e30a9487dc761e54d5d1bade809cff666f432c20fc39bd0dbf3ca4746e7b78dfc7444ca8f6139b5c1818d6971a9a283a23581ffc1b5712dfec35f5bf3

data/README.md

@@ -1,5 +1,5 @@
 # Oracle Cloud Infrastructure Ruby SDK
-**Version 2.3.2**
+**Version 2.3.3**
 
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
 
@@ -8,15 +8,16 @@ This topic describes how to install, configure, and use the Oracle Cloud Infrast
 The Ruby SDK supports the following services:
 
 * Audit
+* Container Engine
 * Core Services (which includes Networking Service, Compute Service, and Block Volume Service)
 * Database Service
+* Domain Name System Service
+* Email Service
+* File Storage Service
 * Identity and Access Management Service
 * Load Balancing Service
 * Object Storage Service
-* Domain Name System Service
-* File Storage Service
-* Email Service
-* Container Engine
+* OCI Search
 
 **Licensing:** This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License.
 

data/lib/oci.rb

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

data/lib/oci/api_client.rb

@@ -521,7 +521,7 @@ module OCI
       return body if (return_type == 'String' && !json_mime?(content_type)) || return_type == 'Stream'
 
       # There are some cases, the error is not returned by services but by like gateway, for example in bug
-      # https://jira.aka.lgl.grungy.us/browse/DEX-564, gateway timeouts and 504 is returned and content is generated
+      # https://jira.oci.oraclecorp.com/browse/DEX-564, gateway timeouts and 504 is returned and content is generated
       # by gateway, so there is no guarantee that the content-type will be application/json.
       if !success?(response) && !response_from_oci_service?(response)
         raise Errors::NetworkError.new(
@@ -625,7 +625,7 @@ module OCI
           return yield
         rescue OCI::Errors::ServiceError => e
           raise if attempt >= (max_attempts - 1) # .times is zero-based
-          raise if e.status != 401
+          raise if e.status_code != 401
 
           @signer.refresh_security_token
           retry

data/lib/oci/auth/federation_client.rb

@@ -97,6 +97,7 @@ module OCI
           request.body = request_payload.to_json
 
           header_params = {}
+          header_params['content-type'] = 'application/json'
           signer.sign(:post, @federation_endpoint, header_params, request.body)
           header_params.each { |key, value| request[key.to_s] = value }
 

data/lib/oci/auth/signers/instance_principals_security_token_signer.rb

@@ -68,7 +68,7 @@ module OCI
                       raw_region
                     end
 
-          @federation_endpoint = if federation_endpoint
+          @federation_endpoint = if defined?(federation_endpoint)
                                    federation_endpoint
                                  else
                                    "#{OCI::Regions.get_service_endpoint(@region, :Auth)}/v1/x509"

data/lib/oci/auth/signers/x509_federation_client_based_security_token_signer.rb

@@ -50,7 +50,8 @@ module OCI
         # @param [String] uri The URI, such as 'https://iaas.us-phoenix-1.oraclecloud.com/20160918/volumeAttachments/'
         # @param [Hash] headers A hash of headers
         # @param [String] body The request body
-        def sign(method, uri, headers, body)
+        # @param [String] operation_signing_strategy the signing strategy for the operation. Default is :standard
+        def sign(method, uri, headers, body, operation_signing_strategy = :standard)
           reset_signer
           super
         end

data/lib/oci/core/compute_client.rb

@@ -1751,11 +1751,13 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Lists the available images in the specified compartment.
-    # If you specify a value for the `sortBy` parameter, Oracle-provided images appear first in the list, followed by custom images.
-    # For more
-    # information about images, see
-    # [Managing Custom Images](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm).
+    # Lists the available images in the specified compartment, including both
+    # [Oracle-provided images](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/images.htm) and
+    # [custom images](https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm) that have
+    # been created. The list of images returned is ordered to first show all
+    # Oracle-provided images, then all custom images.
+    #
+    # The order of images returned may change when new images are released.
     #
     # @param [String] compartment_id The OCID of the compartment.
     # @param [Hash] opts the optional parameters

data/lib/oci/core/models/create_boot_volume_details.rb

@@ -13,6 +13,12 @@ module OCI
     # @return [String]
     attr_accessor :availability_domain
 
+    # If provided, specifies the ID of the boot volume backup policy to assign to the newly
+    # created boot volume. If omitted, no policy will be assigned.
+    #
+    # @return [String]
+    attr_accessor :backup_policy_id
+
     # **[Required]** The OCID of the compartment that contains the boot volume.
     # @return [String]
     attr_accessor :compartment_id
@@ -55,6 +61,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'availability_domain': :'availabilityDomain',
+        'backup_policy_id': :'backupPolicyId',
         'compartment_id': :'compartmentId',
         'defined_tags': :'definedTags',
         'display_name': :'displayName',
@@ -70,6 +77,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'availability_domain': :'String',
+        'backup_policy_id': :'String',
         'compartment_id': :'String',
         'defined_tags': :'Hash<String, Hash<String, Object>>',
         'display_name': :'String',
@@ -87,6 +95,7 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property
+    # @option attributes [String] :backup_policy_id The value to assign to the {#backup_policy_id} property
     # @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property
     # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     # @option attributes [String] :display_name The value to assign to the {#display_name} property
@@ -105,6 +114,12 @@ module OCI
 
       self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']
 
+      self.backup_policy_id = attributes[:'backupPolicyId'] if attributes[:'backupPolicyId']
+
+      raise 'You cannot provide both :backupPolicyId and :backup_policy_id' if attributes.key?(:'backupPolicyId') && attributes.key?(:'backup_policy_id')
+
+      self.backup_policy_id = attributes[:'backup_policy_id'] if attributes[:'backup_policy_id']
+
       self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
 
       raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')
@@ -153,6 +168,7 @@ module OCI
       return true if equal?(other)
       self.class == other.class &&
         availability_domain == other.availability_domain &&
+        backup_policy_id == other.backup_policy_id &&
         compartment_id == other.compartment_id &&
         defined_tags == other.defined_tags &&
         display_name == other.display_name &&
@@ -174,7 +190,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [availability_domain, compartment_id, defined_tags, display_name, freeform_tags, size_in_gbs, source_details].hash
+      [availability_domain, backup_policy_id, compartment_id, defined_tags, display_name, freeform_tags, size_in_gbs, source_details].hash
     end
     # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
 

data/lib/oci/core/models/egress_security_rule.rb

@@ -13,15 +13,29 @@ module OCI
       DESTINATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** The destination service cidrBlock or destination IP address range in CIDR notation for the egress rule.
-    # This is the range of IP addresses that a packet originating from the instance can go to.
+    # **[Required]** Conceptually, this is the range of IP addresses that a packet originating from the instance
+    # can go to.
+    #
+    # Allowed values:
+    #
+    #   * IP address range in CIDR notation. For example: `192.168.1.0/24`
+    #
+    #   * The `cidrBlock` value for a {Service}, if you're
+    #     setting up a security list rule for traffic destined for a particular service through
+    #     a service gateway. For example: `oci-phx-objectstorage`
     #
     # @return [String]
     attr_accessor :destination
 
-    # Type of destination for EgressSecurityRule. SERVICE_CIDR_BLOCK should be used if destination is a service
-    # cidrBlock. CIDR_BLOCK should be used if destination is IP address range in CIDR notation.
-    # It defaults to CIDR_BLOCK, if not specified.
+    # Type of destination for the rule. The default is `CIDR_BLOCK`.
+    #
+    # Allowed values:
+    #
+    #   * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
+    #
+    #   * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
+    #     {Service} (the rule is for traffic destined for a
+    #     particular service through a service gateway).
     #
     # @return [String]
     attr_reader :destination_type

data/lib/oci/core/models/fast_connect_provider_service.rb

@@ -45,7 +45,7 @@ module OCI
     # @return [String]
     attr_accessor :id
 
-    # **[Required]** Private peering BGP management.
+    # **[Required]** Who is responsible for managing the private peering BGP information.
     #
     # @return [String]
     attr_reader :private_peering_bgp_management
@@ -60,7 +60,7 @@ module OCI
     # @return [String]
     attr_accessor :provider_service_name
 
-    # **[Required]** Public peering BGP management.
+    # **[Required]** Who is responsible for managing the public peering BGP information.
     #
     # @return [String]
     attr_reader :public_peering_bgp_management

data/lib/oci/core/models/ingress_security_rule.rb

@@ -42,18 +42,27 @@ module OCI
     # @return [String]
     attr_accessor :protocol
 
-    # **[Required]** The source service cidrBlock or source IP address range in CIDR notation for the ingress rule. This is the
-    # range of IP addresses that a packet coming into the instance can come from.
+    # **[Required]** Conceptually, this is the range of IP addresses that a packet coming into the instance
+    # can come from.
     #
-    # Examples: `10.12.0.0/16`
-    #           `oci-phx-objectstorage`
+    # Allowed values:
+    #
+    #   * IP address range in CIDR notation. For example: `192.168.1.0/24`
+    #
+    #   * The `cidrBlock` value for a {Service}, if you're
+    #     setting up a security list rule for traffic coming from a particular service through
+    #     a service gateway. For example: `oci-phx-objectstorage`
     #
     # @return [String]
     attr_accessor :source
 
-    # Type of source for IngressSecurityRule. SERVICE_CIDR_BLOCK should be used if source is a service cidrBlock.
-    # CIDR_BLOCK should be used if source is IP address range in CIDR notation. It defaults to CIDR_BLOCK, if
-    # not specified.
+    # Type of source for the rule. The default is `CIDR_BLOCK`.
+    #
+    #   * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
+    #
+    #   * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a
+    #     {Service} (the rule is for traffic coming from a
+    #     particular service through a service gateway).
     #
     # @return [String]
     attr_reader :source_type

data/lib/oci/core/models/instance.rb

@@ -65,8 +65,6 @@ module OCI
     #
     # They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
     #
-    # If you don't need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead.
-    #
     # @return [Hash<String, Object>]
     attr_accessor :extended_metadata
 

data/lib/oci/core/models/launch_instance_details.rb

@@ -45,8 +45,6 @@ module OCI
     #
     # They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
     #
-    # If you don't need nested metadata values, it is strongly advised to avoid using this object and use the Metadata object instead.
-    #
     # @return [Hash<String, Object>]
     attr_accessor :extended_metadata
 

data/lib/oci/core/models/route_rule.rb

@@ -15,7 +15,9 @@ module OCI
       DESTINATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # **[Required]** Deprecated, Destination and DestinationType should be used instead; request including both fields will be rejected.
+    # Deprecated. Instead use `destination` and `destinationType`. Requests that include both
+    # `cidrBlock` and `destination` will be rejected.
+    #
     # A destination IP address range in CIDR notation. Matching packets will
     # be routed to the indicated network entity (the target).
     #
@@ -24,18 +26,27 @@ module OCI
     # @return [String]
     attr_accessor :cidr_block
 
-    # The destination service cidrBlock or destination IP address range in CIDR notation. Matching packets will
-    # be routed to the indicated network entity (the target).
+    # Conceptually, this is the range of IP addresses used for matching when routing
+    # traffic. Required if you provide a `destinationType`.
+    #
+    # Allowed values:
     #
-    # Examples: `10.12.0.0/16`
-    #           `oci-phx-objectstorage`
+    #   * IP address range in CIDR notation. For example: `192.168.1.0/24`
+    #
+    #   * The `cidrBlock` value for a {Service}, if you're
+    #     setting up a route rule for traffic destined for a particular service through
+    #     a service gateway. For example: `oci-phx-objectstorage`
     #
     # @return [String]
     attr_accessor :destination
 
-    # Type of destination for the route rule. SERVICE_CIDR_BLOCK should be used if destination is a service
-    # cidrBlock. CIDR_BLOCK should be used if destination is IP address range in CIDR notation. It must be provided
-    # along with `destination`.
+    # Type of destination for the rule. Required if you provide a `destination`.
+    #
+    #   * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
+    #
+    #   * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
+    #     {Service} (the rule is for traffic destined for a
+    #     particular service through a service gateway).
     #
     # @return [String]
     attr_reader :destination_type

data/lib/oci/core/models/virtual_circuit.rb

@@ -70,7 +70,12 @@ module OCI
       TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # The provisioned data rate of the connection.
+    # The provisioned data rate of the connection.  To get a list of the
+    # available bandwidth levels (that is, shapes), see
+    # {#list_fast_connect_provider_virtual_circuit_bandwidth_shapes list_fast_connect_provider_virtual_circuit_bandwidth_shapes}.
+    #
+    # Example: `10 Gbps`
+    #
     # @return [String]
     attr_accessor :bandwidth_shape_name
 

data/lib/oci/regions.rb

@@ -31,7 +31,8 @@ module OCI
       DnsClient: 'dns',
       FileStorageClient: 'filestorage',
       EmailClient: 'email',
-      ContainerEngineClient: 'containerengine'
+      ContainerEngineClient: 'containerengine',
+      ResourceSearchClient: 'query'
     }.freeze
     # --- End of service prefixes ---
 

data/lib/oci/resource_search/models/free_text_search_details.rb

@@ -0,0 +1,158 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require_relative 'search_details'
+
+# rubocop:disable Lint/UnneededCopDisableDirective
+module OCI
+  # A request containing arbitrary text that must be present in the resource.
+  class ResourceSearch::Models::FreeTextSearchDetails < ResourceSearch::Models::SearchDetails # rubocop:disable Metrics/LineLength
+    # **[Required]** The text to search for.
+    # @return [String]
+    attr_accessor :text
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'type': :'type',
+        'matching_context_type': :'matchingContextType',
+        'text': :'text'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'type': :'String',
+        'matching_context_type': :'String',
+        'text': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :matching_context_type The value to assign to the {OCI::ResourceSearch::Models::SearchDetails#matching_context_type #matching_context_type} proprety
+    # @option attributes [String] :text The value to assign to the {#text} property
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      attributes['type'] = 'FreeText'
+
+      super(attributes)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.text = attributes[:'text'] if attributes[:'text']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+      self.class == other.class &&
+        type == other.type &&
+        matching_context_type == other.matching_context_type &&
+        text == other.text
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [type, matching_context_type, text].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          public_method("#{key}=").call(
+            OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
+          )
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective