oci 2.14.0 → 2.15.0

data/lib/oci/jms/models/work_request_log_entry_collection.rb

@@ -0,0 +1,150 @@
+# 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
+  # Results of a work request log entry search. Contains WorkRequestLogEntry items
+  class Jms::Models::WorkRequestLogEntryCollection
+    # **[Required]** A list of work request log entries.
+    # @return [Array<OCI::Jms::Models::WorkRequestLogEntry>]
+    attr_accessor :items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'items': :'items'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'items': :'Array<OCI::Jms::Models::WorkRequestLogEntry>'
+        # 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 [Array<OCI::Jms::Models::WorkRequestLogEntry>] :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.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 &&
+        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
+      [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/jms/models/work_request_resource.rb

@@ -0,0 +1,219 @@
+# 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'
+require 'logger'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
+  class Jms::Models::WorkRequestResource
+    ACTION_TYPE_ENUM = [
+      ACTION_TYPE_CREATED = 'CREATED'.freeze,
+      ACTION_TYPE_DELETED = 'DELETED'.freeze,
+      ACTION_TYPE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
+      ACTION_TYPE_RELATED = 'RELATED'.freeze,
+      ACTION_TYPE_UPDATED = 'UPDATED'.freeze,
+      ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    # **[Required]** The resource type affected by the work request.
+    # @return [String]
+    attr_accessor :entity_type
+
+    # **[Required]** The way in which this resource was affected by the operation that spawned the work request.
+    # A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
+    # work is complete for that resource at which point it will transition to CREATED, UPDATED,
+    # or DELETED, respectively.
+    #
+    # @return [String]
+    attr_reader :action_type
+
+    # **[Required]** An [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) or other unique identifier of the resource affected by the work request.
+    # @return [String]
+    attr_accessor :identifier
+
+    # The URI path that the user can perform a GET operation to access the resource metadata.
+    # @return [String]
+    attr_accessor :entity_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'entity_type': :'entityType',
+        'action_type': :'actionType',
+        'identifier': :'identifier',
+        'entity_uri': :'entityUri'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'entity_type': :'String',
+        'action_type': :'String',
+        'identifier': :'String',
+        'entity_uri': :'String'
+        # 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 [String] :entity_type The value to assign to the {#entity_type} property
+    # @option attributes [String] :action_type The value to assign to the {#action_type} property
+    # @option attributes [String] :identifier The value to assign to the {#identifier} property
+    # @option attributes [String] :entity_uri The value to assign to the {#entity_uri} 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.entity_type = attributes[:'entityType'] if attributes[:'entityType']
+
+      raise 'You cannot provide both :entityType and :entity_type' if attributes.key?(:'entityType') && attributes.key?(:'entity_type')
+
+      self.entity_type = attributes[:'entity_type'] if attributes[:'entity_type']
+
+      self.action_type = attributes[:'actionType'] if attributes[:'actionType']
+
+      raise 'You cannot provide both :actionType and :action_type' if attributes.key?(:'actionType') && attributes.key?(:'action_type')
+
+      self.action_type = attributes[:'action_type'] if attributes[:'action_type']
+
+      self.identifier = attributes[:'identifier'] if attributes[:'identifier']
+
+      self.entity_uri = attributes[:'entityUri'] if attributes[:'entityUri']
+
+      raise 'You cannot provide both :entityUri and :entity_uri' if attributes.key?(:'entityUri') && attributes.key?(:'entity_uri')
+
+      self.entity_uri = attributes[:'entity_uri'] if attributes[:'entity_uri']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_type Object to be assigned
+    def action_type=(action_type)
+      # rubocop:disable Style/ConditionalAssignment
+      if action_type && !ACTION_TYPE_ENUM.include?(action_type)
+        OCI.logger.debug("Unknown value for 'action_type' [" + action_type + "]. Mapping to 'ACTION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        @action_type = ACTION_TYPE_UNKNOWN_ENUM_VALUE
+      else
+        @action_type = action_type
+      end
+      # rubocop:enable Style/ConditionalAssignment
+    end
+
+    # 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 &&
+        entity_type == other.entity_type &&
+        action_type == other.action_type &&
+        identifier == other.identifier &&
+        entity_uri == other.entity_uri
+    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
+      [entity_type, action_type, identifier, entity_uri].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/jms/util.rb

@@ -0,0 +1,3 @@
+# 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.
+

data/lib/oci/limits/limits_client.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # APIs that interact with the resource limits of a specific resource type
+  # APIs that interact with the resource limits of a specific resource type.
   class Limits::LimitsClient
     # Client used to make HTTP requests.
     # @return [OCI::ApiClient]
@@ -99,9 +99,9 @@ module OCI
 
 
     # For a given compartmentId, resource limit name, and scope, returns the following:
-    #   - the number of available resources associated with the given limit
-    #   - the usage in the selected compartment for the given limit
-    #   Note: not all resource limits support this API. If the value is not available, the API will return 404.
+    #   * The number of available resources associated with the given limit.
+    #   * The usage in the selected compartment for the given limit.
+    #   Note that not all resource limits support this API. If the value is not available, the API returns a 404 response.
     #
     # @param [String] service_name The service name of the target quota.
     # @param [String] limit_name The limit name for which to fetch the data.
@@ -111,7 +111,7 @@ module OCI
     #   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] :availability_domain This field is mandatory if the scopeType of the target resource limit is AD.
     #   Otherwise, this field should be omitted.
-    #   If the above requirements are not met, the API will return a 400 - InvalidParameter response.
+    #   If the above requirements are not met, the API returns a 400 - InvalidParameter response.
     #
     # @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.
@@ -183,7 +183,7 @@ module OCI
     # @option opts [String] :sort_by The field to sort by.
     #    (default to name)
     #   Allowed values are: name, description
-    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
+    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. By default, it is ascending.
     #    (default to ASC)
     #   Allowed values are: ASC, DESC
     # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
@@ -259,19 +259,19 @@ module OCI
     #
     # @param [String] compartment_id The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
     #
-    # @param [String] service_name The target service name
+    # @param [String] service_name The target service name.
     # @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] :scope_type Filter entries by scope type.
     #   Allowed values are: GLOBAL, REGION, AD
-    # @option opts [String] :availability_domain Filter entries by availability domain. This implies that only AD-specific values will be returned.
+    # @option opts [String] :availability_domain Filter entries by availability domain. This implies that only AD-specific values are returned.
     #
     # @option opts [String] :name Optional field, can be used to see a specific resource limit value.
-    # @option opts [String] :sort_by The field to sort by. We will be implicitly sorting by availabilityDomain, as a second level field, if available.
+    # @option opts [String] :sort_by The field to sort by. The sorting is by availabilityDomain, as a second level field, if available.
     #    (default to name)
     #   Allowed values are: name
-    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
+    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. By default, it is ascending.
     #    (default to ASC)
     #   Allowed values are: ASC, DESC
     # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
@@ -351,7 +351,7 @@ module OCI
 
 
     # Returns the list of supported services.
-    # This will include the programmatic service name, along with the friendly service name.
+    # This includes the programmatic service name, along with the friendly service name.
     #
     # @param [String] compartment_id The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
     #
@@ -361,7 +361,7 @@ module OCI
     # @option opts [String] :sort_by The field to sort by.
     #    (default to name)
     #   Allowed values are: name, description
-    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. By default it will be ascending.
+    # @option opts [String] :sort_order The sort order to use, either 'asc' or 'desc'. By default, it is ascending.
     #    (default to ASC)
     #   Allowed values are: ASC, DESC
     # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.