oci 2.13.0 → 2.14.0

data/lib/oci/data_catalog/models/suggest_results.rb

@@ -0,0 +1,194 @@
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # The list of potential matches returned from the suggest operation for the given input text. The size of the list will be determined
+  # by the limit parameter.
+  #
+  class DataCatalog::Models::SuggestResults
+    # **[Required]** Total number of items returned.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Time taken to compute the result, in milliseconds.
+    # @return [Integer]
+    attr_accessor :search_latency_in_ms
+
+    # **[Required]** Input string for which the potential matches are computed.
+    # @return [String]
+    attr_accessor :input_text
+
+    # List of suggestions.
+    # @return [Array<OCI::DataCatalog::Models::SuggestListItem>]
+    attr_accessor :items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'total_count': :'totalCount',
+        'search_latency_in_ms': :'searchLatencyInMs',
+        'input_text': :'inputText',
+        'items': :'items'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'total_count': :'Integer',
+        'search_latency_in_ms': :'Integer',
+        'input_text': :'String',
+        'items': :'Array<OCI::DataCatalog::Models::SuggestListItem>'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Integer] :total_count The value to assign to the {#total_count} property
+    # @option attributes [Integer] :search_latency_in_ms The value to assign to the {#search_latency_in_ms} property
+    # @option attributes [String] :input_text The value to assign to the {#input_text} property
+    # @option attributes [Array<OCI::DataCatalog::Models::SuggestListItem>] :items The value to assign to the {#items} property
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.total_count = attributes[:'totalCount'] if attributes[:'totalCount']
+
+      raise 'You cannot provide both :totalCount and :total_count' if attributes.key?(:'totalCount') && attributes.key?(:'total_count')
+
+      self.total_count = attributes[:'total_count'] if attributes[:'total_count']
+
+      self.search_latency_in_ms = attributes[:'searchLatencyInMs'] if attributes[:'searchLatencyInMs']
+
+      raise 'You cannot provide both :searchLatencyInMs and :search_latency_in_ms' if attributes.key?(:'searchLatencyInMs') && attributes.key?(:'search_latency_in_ms')
+
+      self.search_latency_in_ms = attributes[:'search_latency_in_ms'] if attributes[:'search_latency_in_ms']
+
+      self.input_text = attributes[:'inputText'] if attributes[:'inputText']
+
+      raise 'You cannot provide both :inputText and :input_text' if attributes.key?(:'inputText') && attributes.key?(:'input_text')
+
+      self.input_text = attributes[:'input_text'] if attributes[:'input_text']
+
+      self.items = attributes[:'items'] if attributes[:'items']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable 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 &&
+        total_count == other.total_count &&
+        search_latency_in_ms == other.search_latency_in_ms &&
+        input_text == other.input_text &&
+        items == other.items
+    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, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [total_count, search_latency_in_ms, input_text, items].hash
+    end
+    # rubocop:enable Metrics/AbcSize, 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, Metrics/LineLength

data/lib/oci/data_catalog/models/update_attribute_details.rb

@@ -13,6 +13,10 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
+    # Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
+    # @return [String]
+    attr_accessor :business_name
+
     # Detailed description of the attribute.
     # @return [String]
     attr_accessor :description
@@ -89,6 +93,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'display_name': :'displayName',
+        'business_name': :'businessName',
         'description': :'description',
         'external_data_type': :'externalDataType',
         'is_incremental_data': :'isIncrementalData',
@@ -113,6 +118,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'display_name': :'String',
+        'business_name': :'String',
         'description': :'String',
         'external_data_type': :'String',
         'is_incremental_data': :'BOOLEAN',
@@ -139,6 +145,7 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :display_name The value to assign to the {#display_name} property
+    # @option attributes [String] :business_name The value to assign to the {#business_name} property
     # @option attributes [String] :description The value to assign to the {#description} property
     # @option attributes [String] :external_data_type The value to assign to the {#external_data_type} property
     # @option attributes [BOOLEAN] :is_incremental_data The value to assign to the {#is_incremental_data} property
@@ -166,6 +173,12 @@ module OCI
 
       self.display_name = attributes[:'display_name'] if attributes[:'display_name']
 
+      self.business_name = attributes[:'businessName'] if attributes[:'businessName']
+
+      raise 'You cannot provide both :businessName and :business_name' if attributes.key?(:'businessName') && attributes.key?(:'business_name')
+
+      self.business_name = attributes[:'business_name'] if attributes[:'business_name']
+
       self.description = attributes[:'description'] if attributes[:'description']
 
       self.external_data_type = attributes[:'externalDataType'] if attributes[:'externalDataType']
@@ -245,6 +258,7 @@ module OCI
 
       self.class == other.class &&
         display_name == other.display_name &&
+        business_name == other.business_name &&
         description == other.description &&
         external_data_type == other.external_data_type &&
         is_incremental_data == other.is_incremental_data &&
@@ -275,7 +289,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [display_name, description, external_data_type, is_incremental_data, is_nullable, length, position, precision, scale, time_external, min_collection_count, max_collection_count, external_datatype_entity_key, external_parent_attribute_key, custom_property_members, properties].hash
+      [display_name, business_name, description, external_data_type, is_incremental_data, is_nullable, length, position, precision, scale, time_external, min_collection_count, max_collection_count, external_datatype_entity_key, external_parent_attribute_key, custom_property_members, properties].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/data_catalog/models/update_connection_details.rb

@@ -40,7 +40,7 @@ module OCI
     # To determine the set of optional and required properties for a connection type, a query can be done
     # on '/types?type=connection' that returns a collection of all connection types. The appropriate connection
     # type, which will include definitions of all of it's properties, can be identified from this collection.
-    # Example: `{\"encProperties\": { \"default\": { \"password\": \"pwd\"}}}`
+    # Example: `{\"encProperties\": { \"default\": { \"password\": \"example-password\"}}}`
     #
     # @return [Hash<String, Hash<String, String>>]
     attr_accessor :enc_properties

data/lib/oci/data_catalog/models/update_custom_property_details.rb

@@ -37,6 +37,10 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :is_editable
 
+    # If this field is displayed in a list view of applicable objects.
+    # @return [BOOLEAN]
+    attr_accessor :is_shown_in_list
+
     # If this field is allowed to pop in search results
     # @return [BOOLEAN]
     attr_accessor :is_hidden_in_search
@@ -65,6 +69,7 @@ module OCI
         'is_multi_valued': :'isMultiValued',
         'is_hidden': :'isHidden',
         'is_editable': :'isEditable',
+        'is_shown_in_list': :'isShownInList',
         'is_hidden_in_search': :'isHiddenInSearch',
         'allowed_values': :'allowedValues',
         'properties': :'properties'
@@ -83,6 +88,7 @@ module OCI
         'is_multi_valued': :'BOOLEAN',
         'is_hidden': :'BOOLEAN',
         'is_editable': :'BOOLEAN',
+        'is_shown_in_list': :'BOOLEAN',
         'is_hidden_in_search': :'BOOLEAN',
         'allowed_values': :'Array<String>',
         'properties': :'Hash<String, Hash<String, String>>'
@@ -103,6 +109,7 @@ module OCI
     # @option attributes [BOOLEAN] :is_multi_valued The value to assign to the {#is_multi_valued} property
     # @option attributes [BOOLEAN] :is_hidden The value to assign to the {#is_hidden} property
     # @option attributes [BOOLEAN] :is_editable The value to assign to the {#is_editable} property
+    # @option attributes [BOOLEAN] :is_shown_in_list The value to assign to the {#is_shown_in_list} property
     # @option attributes [BOOLEAN] :is_hidden_in_search The value to assign to the {#is_hidden_in_search} property
     # @option attributes [Array<String>] :allowed_values The value to assign to the {#allowed_values} property
     # @option attributes [Hash<String, Hash<String, String>>] :properties The value to assign to the {#properties} property
@@ -160,6 +167,14 @@ module OCI
       self.is_editable = attributes[:'is_editable'] unless attributes[:'is_editable'].nil?
       self.is_editable = true if is_editable.nil? && !attributes.key?(:'isEditable') && !attributes.key?(:'is_editable') # rubocop:disable Style/StringLiterals
 
+      self.is_shown_in_list = attributes[:'isShownInList'] unless attributes[:'isShownInList'].nil?
+      self.is_shown_in_list = false if is_shown_in_list.nil? && !attributes.key?(:'isShownInList') # rubocop:disable Style/StringLiterals
+
+      raise 'You cannot provide both :isShownInList and :is_shown_in_list' if attributes.key?(:'isShownInList') && attributes.key?(:'is_shown_in_list')
+
+      self.is_shown_in_list = attributes[:'is_shown_in_list'] unless attributes[:'is_shown_in_list'].nil?
+      self.is_shown_in_list = false if is_shown_in_list.nil? && !attributes.key?(:'isShownInList') && !attributes.key?(:'is_shown_in_list') # rubocop:disable Style/StringLiterals
+
       self.is_hidden_in_search = attributes[:'isHiddenInSearch'] unless attributes[:'isHiddenInSearch'].nil?
       self.is_hidden_in_search = false if is_hidden_in_search.nil? && !attributes.key?(:'isHiddenInSearch') # rubocop:disable Style/StringLiterals
 
@@ -195,6 +210,7 @@ module OCI
         is_multi_valued == other.is_multi_valued &&
         is_hidden == other.is_hidden &&
         is_editable == other.is_editable &&
+        is_shown_in_list == other.is_shown_in_list &&
         is_hidden_in_search == other.is_hidden_in_search &&
         allowed_values == other.allowed_values &&
         properties == other.properties
@@ -213,7 +229,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [display_name, description, is_sortable, is_filterable, is_multi_valued, is_hidden, is_editable, is_hidden_in_search, allowed_values, properties].hash
+      [display_name, description, is_sortable, is_filterable, is_multi_valued, is_hidden, is_editable, is_shown_in_list, is_hidden_in_search, allowed_values, properties].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/data_catalog/models/update_entity_details.rb

@@ -20,6 +20,10 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
+    # Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
+    # @return [String]
+    attr_accessor :business_name
+
     # Detailed description of a data entity.
     # @return [String]
     attr_accessor :description
@@ -81,6 +85,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'display_name': :'displayName',
+        'business_name': :'businessName',
         'description': :'description',
         'time_external': :'timeExternal',
         'is_logical': :'isLogical',
@@ -101,6 +106,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'display_name': :'String',
+        'business_name': :'String',
         'description': :'String',
         'time_external': :'DateTime',
         'is_logical': :'BOOLEAN',
@@ -123,6 +129,7 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :display_name The value to assign to the {#display_name} property
+    # @option attributes [String] :business_name The value to assign to the {#business_name} property
     # @option attributes [String] :description The value to assign to the {#description} property
     # @option attributes [DateTime] :time_external The value to assign to the {#time_external} property
     # @option attributes [BOOLEAN] :is_logical The value to assign to the {#is_logical} property
@@ -146,6 +153,12 @@ module OCI
 
       self.display_name = attributes[:'display_name'] if attributes[:'display_name']
 
+      self.business_name = attributes[:'businessName'] if attributes[:'businessName']
+
+      raise 'You cannot provide both :businessName and :business_name' if attributes.key?(:'businessName') && attributes.key?(:'business_name')
+
+      self.business_name = attributes[:'business_name'] if attributes[:'business_name']
+
       self.description = attributes[:'description'] if attributes[:'description']
 
       self.time_external = attributes[:'timeExternal'] if attributes[:'timeExternal']
@@ -225,6 +238,7 @@ module OCI
 
       self.class == other.class &&
         display_name == other.display_name &&
+        business_name == other.business_name &&
         description == other.description &&
         time_external == other.time_external &&
         is_logical == other.is_logical &&
@@ -251,7 +265,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [display_name, description, time_external, is_logical, is_partition, folder_key, pattern_key, realized_expression, harvest_status, last_job_key, custom_property_members, properties].hash
+      [display_name, business_name, description, time_external, is_logical, is_partition, folder_key, pattern_key, realized_expression, harvest_status, last_job_key, custom_property_members, properties].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

data/lib/oci/data_catalog/models/update_folder_details.rb

@@ -20,6 +20,10 @@ module OCI
     # @return [String]
     attr_accessor :display_name
 
+    # Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
+    # @return [String]
+    attr_accessor :business_name
+
     # Detailed description of a folder.
     # @return [String]
     attr_accessor :description
@@ -61,6 +65,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'display_name': :'displayName',
+        'business_name': :'businessName',
         'description': :'description',
         'parent_folder_key': :'parentFolderKey',
         'custom_property_members': :'customPropertyMembers',
@@ -77,6 +82,7 @@ module OCI
       {
         # rubocop:disable Style/SymbolLiteral
         'display_name': :'String',
+        'business_name': :'String',
         'description': :'String',
         'parent_folder_key': :'String',
         'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertySetUsage>',
@@ -95,6 +101,7 @@ module OCI
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     # @option attributes [String] :display_name The value to assign to the {#display_name} property
+    # @option attributes [String] :business_name The value to assign to the {#business_name} property
     # @option attributes [String] :description The value to assign to the {#description} property
     # @option attributes [String] :parent_folder_key The value to assign to the {#parent_folder_key} property
     # @option attributes [Array<OCI::DataCatalog::Models::CustomPropertySetUsage>] :custom_property_members The value to assign to the {#custom_property_members} property
@@ -114,6 +121,12 @@ module OCI
 
       self.display_name = attributes[:'display_name'] if attributes[:'display_name']
 
+      self.business_name = attributes[:'businessName'] if attributes[:'businessName']
+
+      raise 'You cannot provide both :businessName and :business_name' if attributes.key?(:'businessName') && attributes.key?(:'business_name')
+
+      self.business_name = attributes[:'business_name'] if attributes[:'business_name']
+
       self.description = attributes[:'description'] if attributes[:'description']
 
       self.parent_folder_key = attributes[:'parentFolderKey'] if attributes[:'parentFolderKey']
@@ -169,6 +182,7 @@ module OCI
 
       self.class == other.class &&
         display_name == other.display_name &&
+        business_name == other.business_name &&
         description == other.description &&
         parent_folder_key == other.parent_folder_key &&
         custom_property_members == other.custom_property_members &&
@@ -191,7 +205,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [display_name, description, parent_folder_key, custom_property_members, properties, time_external, harvest_status, last_job_key].hash
+      [display_name, business_name, description, parent_folder_key, custom_property_members, properties, time_external, harvest_status, last_job_key].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines