oci 2.1.0 → 2.1.1

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

@@ -1,7 +1,9 @@
 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 require 'date'
+require 'logger'
 
+# rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
   # A *public IP* is a conceptual term that refers to a public IP address and related properties.
   # The `publicIp` object is the API representation of a public IP.
@@ -13,47 +15,50 @@ module OCI
   # For more information and comparison of the two types,
   # see [Public IP Addresses](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).
   #
-  class Core::Models::PublicIp
-
-    LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
-                LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
-                LIFECYCLE_STATE_ASSIGNING = 'ASSIGNING',
-                LIFECYCLE_STATE_ASSIGNED = 'ASSIGNED',
-                LIFECYCLE_STATE_UNASSIGNING = 'UNASSIGNING',
-                LIFECYCLE_STATE_UNASSIGNED = 'UNASSIGNED',
-                LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
-                LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
-                LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
-
-
-    LIFETIME_ENUM = [LIFETIME_EPHEMERAL = 'EPHEMERAL',
-                LIFETIME_RESERVED = 'RESERVED',
-                LIFETIME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
-
-
-    SCOPE_ENUM = [SCOPE_REGION = 'REGION',
-                SCOPE_AVAILABILITY_DOMAIN = 'AVAILABILITY_DOMAIN',
-                SCOPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+  class Core::Models::PublicIp # rubocop:disable Metrics/LineLength
+    LIFECYCLE_STATE_ENUM = [
+      LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
+      LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
+      LIFECYCLE_STATE_ASSIGNING = 'ASSIGNING'.freeze,
+      LIFECYCLE_STATE_ASSIGNED = 'ASSIGNED'.freeze,
+      LIFECYCLE_STATE_UNASSIGNING = 'UNASSIGNING'.freeze,
+      LIFECYCLE_STATE_UNASSIGNED = 'UNASSIGNED'.freeze,
+      LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
+      LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
+      LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    LIFETIME_ENUM = [
+      LIFETIME_EPHEMERAL = 'EPHEMERAL'.freeze,
+      LIFETIME_RESERVED = 'RESERVED'.freeze,
+      LIFETIME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
+
+    SCOPE_ENUM = [
+      SCOPE_REGION = 'REGION'.freeze,
+      SCOPE_AVAILABILITY_DOMAIN = 'AVAILABILITY_DOMAIN'.freeze,
+      SCOPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
+    ].freeze
 
     # The public IP's Availability Domain. This property is set only for ephemeral public IPs
     # (that is, when the `scope` of the public IP is set to AVAILABILITY_DOMAIN). The value
     # is the Availability Domain of the assigned private IP.
-    # 
+    #
     # Example: `Uocm:PHX-AD-1`
-    # 
+    #
     # @return [String]
     attr_accessor :availability_domain
 
     # The OCID of the compartment containing the public IP. For an ephemeral public IP, this is
     # the same compartment as the private IP's. For a reserved public IP that is currently assigned,
     # this can be a different compartment than the assigned private IP's.
-    # 
+    #
     # @return [String]
     attr_accessor :compartment_id
 
     # A user-friendly name. Does not have to be unique, and it's changeable. Avoid
     # entering confidential information.
-    # 
+    #
     # @return [String]
     attr_accessor :display_name
 
@@ -62,57 +67,96 @@ module OCI
     attr_accessor :id
 
     # The public IP address of the `publicIp` object.
-    # 
+    #
     # Example: `129.146.2.1`
-    # 
+    #
     # @return [String]
     attr_accessor :ip_address
 
     # The public IP's current state.
     # @return [String]
-    attr_accessor :lifecycle_state
+    attr_reader :lifecycle_state
 
     # Defines when the public IP is deleted and released back to Oracle's public IP pool.
-    # 
+    #
     # * `EPHEMERAL`: The lifetime is tied to the lifetime of its assigned private IP. The
     # ephemeral public IP is automatically deleted when its private IP is deleted, when
     # the VNIC is terminated, or when the instance is terminated. An ephemeral
     # public IP must always be assigned to a private IP.
-    # 
+    #
     # * `RESERVED`: You control the public IP's lifetime. You can delete a reserved public IP
     # whenever you like. It does not need to be assigned to a private IP at all times.
-    # 
+    #
     # For more information and comparison of the two types,
     # see [Public IP Addresses](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).
-    # 
+    #
     # @return [String]
-    attr_accessor :lifetime
+    attr_reader :lifetime
 
     # The OCID of the private IP that the public IP is currently assigned to, or in the
     # process of being assigned to.
-    # 
+    #
     # @return [String]
     attr_accessor :private_ip_id
 
     # Whether the public IP is regional or specific to a particular Availability Domain.
-    # 
+    #
     # * `REGION`: The public IP exists within a region and can be assigned to a private IP
     # in any Availability Domain in the region. Reserved public IPs have `scope` = `REGION`.
-    # 
+    #
     # * `AVAILABILITY_DOMAIN`: The public IP exists within the Availability Domain of the private IP
     # it's assigned to, which is specified by the `availabilityDomain` property of the public IP object.
     # Ephemeral public IPs have `scope` = `AVAILABILITY_DOMAIN`.
-    # 
+    #
     # @return [String]
-    attr_accessor :scope
+    attr_reader :scope
 
     # The date and time the public IP was created, in the format defined by RFC3339.
-    # 
+    #
     # Example: `2016-08-25T21:10:29.600Z`
-    # 
+    #
     # @return [DateTime]
     attr_accessor :time_created
 
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'availability_domain': :'availabilityDomain',
+        'compartment_id': :'compartmentId',
+        'display_name': :'displayName',
+        'id': :'id',
+        'ip_address': :'ipAddress',
+        'lifecycle_state': :'lifecycleState',
+        'lifetime': :'lifetime',
+        'private_ip_id': :'privateIpId',
+        'scope': :'scope',
+        'time_created': :'timeCreated'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'availability_domain': :'String',
+        'compartment_id': :'String',
+        'display_name': :'String',
+        'id': :'String',
+        'ip_address': :'String',
+        'lifecycle_state': :'String',
+        'lifetime': :'String',
+        'private_ip_id': :'String',
+        'scope': :'String',
+        'time_created': :'DateTime'
+        # 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
@@ -130,150 +174,143 @@ module OCI
       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}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes[:'availabilityDomain']
-        self.availability_domain = attributes[:'availabilityDomain']
-      end
+      self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']
 
       raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain')
 
-      if attributes[:'availability_domain']
-        self.availability_domain = attributes[:'availability_domain']
-      end
+      self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain']
 
-      if attributes[:'compartmentId']
-        self.compartment_id = attributes[:'compartmentId']
-      end
+      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')
 
-      if attributes[:'compartment_id']
-        self.compartment_id = attributes[:'compartment_id']
-      end
+      self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
 
-      if attributes[:'displayName']
-        self.display_name = attributes[:'displayName']
-      end
+      self.display_name = attributes[:'displayName'] if attributes[:'displayName']
 
       raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')
 
-      if attributes[:'display_name']
-        self.display_name = attributes[:'display_name']
-      end
+      self.display_name = attributes[:'display_name'] if attributes[:'display_name']
 
-      if attributes[:'id']
-        self.id = attributes[:'id']
-      end
+      self.id = attributes[:'id'] if attributes[:'id']
 
-      if attributes[:'ipAddress']
-        self.ip_address = attributes[:'ipAddress']
-      end
+      self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress']
 
       raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address')
 
-      if attributes[:'ip_address']
-        self.ip_address = attributes[:'ip_address']
-      end
+      self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address']
 
-      if attributes[:'lifecycleState']
-        self.lifecycle_state = attributes[:'lifecycleState']
-      end
+      self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']
 
       raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')
 
-      if attributes[:'lifecycle_state']
-        self.lifecycle_state = attributes[:'lifecycle_state']
-      end
+      self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']
 
-      if attributes[:'lifetime']
-        self.lifetime = attributes[:'lifetime']
-      end
+      self.lifetime = attributes[:'lifetime'] if attributes[:'lifetime']
 
-      if attributes[:'privateIpId']
-        self.private_ip_id = attributes[:'privateIpId']
-      end
+      self.private_ip_id = attributes[:'privateIpId'] if attributes[:'privateIpId']
 
       raise 'You cannot provide both :privateIpId and :private_ip_id' if attributes.key?(:'privateIpId') && attributes.key?(:'private_ip_id')
 
-      if attributes[:'private_ip_id']
-        self.private_ip_id = attributes[:'private_ip_id']
-      end
+      self.private_ip_id = attributes[:'private_ip_id'] if attributes[:'private_ip_id']
 
-      if attributes[:'scope']
-        self.scope = attributes[:'scope']
-      end
+      self.scope = attributes[:'scope'] if attributes[:'scope']
 
-      if attributes[:'timeCreated']
-        self.time_created = attributes[:'timeCreated']
-      end
+      self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']
 
       raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
 
-      if attributes[:'time_created']
-        self.time_created = attributes[:'time_created']
-      end
-
+      self.time_created = attributes[:'time_created'] if attributes[:'time_created']
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] lifecycle_state Object to be assigned
     def lifecycle_state=(lifecycle_state)
+      # rubocop:disable Style/ConditionalAssignment
       if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
+        # rubocop: disable Metrics/LineLength
+        OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        # rubocop: enable Metrics/LineLength
         @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
       else
         @lifecycle_state = lifecycle_state
       end
+      # rubocop:enable Style/ConditionalAssignment
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] lifetime Object to be assigned
     def lifetime=(lifetime)
+      # rubocop:disable Style/ConditionalAssignment
       if lifetime && !LIFETIME_ENUM.include?(lifetime)
+        # rubocop: disable Metrics/LineLength
+        OCI.logger.debug("Unknown value for 'lifetime' [" + lifetime + "]. Mapping to 'LIFETIME_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        # rubocop: enable Metrics/LineLength
         @lifetime = LIFETIME_UNKNOWN_ENUM_VALUE
       else
         @lifetime = lifetime
       end
+      # rubocop:enable Style/ConditionalAssignment
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] scope Object to be assigned
     def scope=(scope)
+      # rubocop:disable Style/ConditionalAssignment
       if scope && !SCOPE_ENUM.include?(scope)
+        # rubocop: disable Metrics/LineLength
+        OCI.logger.debug("Unknown value for 'scope' [" + scope + "]. Mapping to 'SCOPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
+        # rubocop: enable Metrics/LineLength
         @scope = SCOPE_UNKNOWN_ENUM_VALUE
       else
         @scope = scope
       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_object to be compared
-    def ==(other_object)
-      return true if self.equal?(other_object)
-      self.class == other_object.class &&
-          availability_domain == other_object.availability_domain &&
-          compartment_id == other_object.compartment_id &&
-          display_name == other_object.display_name &&
-          id == other_object.id &&
-          ip_address == other_object.ip_address &&
-          lifecycle_state == other_object.lifecycle_state &&
-          lifetime == other_object.lifetime &&
-          private_ip_id == other_object.private_ip_id &&
-          scope == other_object.scope &&
-          time_created == other_object.time_created
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+      self.class == other.class &&
+        availability_domain == other.availability_domain &&
+        compartment_id == other.compartment_id &&
+        display_name == other.display_name &&
+        id == other.id &&
+        ip_address == other.ip_address &&
+        lifecycle_state == other.lifecycle_state &&
+        lifetime == other.lifetime &&
+        private_ip_id == other.private_ip_id &&
+        scope == other.scope &&
+        time_created == other.time_created
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
     # @see the `==` method
-    # @param [Object] other_object to be compared
-    def eql?(other_object)
-      self == other_object
+    # @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
       [availability_domain, compartment_id, display_name, id, ip_address, lifecycle_state, lifetime, private_ip_id, scope, time_created].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
@@ -285,15 +322,22 @@ module OCI
           # 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)
-            self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
+            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?
-          self.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
+          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
@@ -317,11 +361,11 @@ module OCI
 
     # 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 
+    # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -332,39 +376,6 @@ module OCI
         value
       end
     end
-
-
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      { 
-        :'availability_domain' => :'availabilityDomain',
-        :'compartment_id' => :'compartmentId',
-        :'display_name' => :'displayName',
-        :'id' => :'id',
-        :'ip_address' => :'ipAddress',
-        :'lifecycle_state' => :'lifecycleState',
-        :'lifetime' => :'lifetime',
-        :'private_ip_id' => :'privateIpId',
-        :'scope' => :'scope',
-        :'time_created' => :'timeCreated'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      { 
-        :'availability_domain' => :'String',
-        :'compartment_id' => :'String',
-        :'display_name' => :'String',
-        :'id' => :'String',
-        :'ip_address' => :'String',
-        :'lifecycle_state' => :'String',
-        :'lifetime' => :'String',
-        :'private_ip_id' => :'String',
-        :'scope' => :'String',
-        :'time_created' => :'DateTime'
-      }
-    end
   end
 end
+# rubocop:enable Lint/UnneededCopDisableDirective