oci 2.5.9 → 2.5.10

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

@@ -0,0 +1,153 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # AddNetworkSecurityGroupSecurityRulesDetails model.
+  class Core::Models::AddNetworkSecurityGroupSecurityRulesDetails
+    # The NSG security rules to add.
+    # @return [Array<OCI::Core::Models::AddSecurityRuleDetails>]
+    attr_accessor :security_rules
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'security_rules': :'securityRules'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'security_rules': :'Array<OCI::Core::Models::AddSecurityRuleDetails>'
+        # 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::Core::Models::AddSecurityRuleDetails>] :security_rules The value to assign to the {#security_rules} 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.security_rules = attributes[:'securityRules'] if attributes[:'securityRules']
+
+      raise 'You cannot provide both :securityRules and :security_rules' if attributes.key?(:'securityRules') && attributes.key?(:'security_rules')
+
+      self.security_rules = attributes[:'security_rules'] if attributes[:'security_rules']
+    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 &&
+        security_rules == other.security_rules
+    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
+      [security_rules].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/core/models/add_security_rule_details.rb

@@ -0,0 +1,388 @@
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A rule for allowing inbound (INGRESS) or outbound (EGRESS) IP packets.
+  class Core::Models::AddSecurityRuleDetails
+    DESTINATION_TYPE_ENUM = [
+      DESTINATION_TYPE_CIDR_BLOCK = 'CIDR_BLOCK'.freeze,
+      DESTINATION_TYPE_SERVICE_CIDR_BLOCK = 'SERVICE_CIDR_BLOCK'.freeze,
+      DESTINATION_TYPE_NETWORK_SECURITY_GROUP = 'NETWORK_SECURITY_GROUP'.freeze
+    ].freeze
+
+    DIRECTION_ENUM = [
+      DIRECTION_EGRESS = 'EGRESS'.freeze,
+      DIRECTION_INGRESS = 'INGRESS'.freeze
+    ].freeze
+
+    SOURCE_TYPE_ENUM = [
+      SOURCE_TYPE_CIDR_BLOCK = 'CIDR_BLOCK'.freeze,
+      SOURCE_TYPE_SERVICE_CIDR_BLOCK = 'SERVICE_CIDR_BLOCK'.freeze,
+      SOURCE_TYPE_NETWORK_SECURITY_GROUP = 'NETWORK_SECURITY_GROUP'.freeze
+    ].freeze
+
+    # An optional description of your choice for the rule.
+    #
+    # @return [String]
+    attr_accessor :description
+
+    # Conceptually, this is the range of IP addresses that a packet originating from the instance
+    # can go to.
+    #
+    # Allowed values:
+    #
+    #   * An 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 rule for traffic destined for a particular `Service` through
+    #     a service gateway. For example: `oci-phx-objectstorage`.
+    #
+    #   * The OCID of a {NetworkSecurityGroup} in the same
+    #     VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
+    #     traffic between VNICs in the same NSG.
+    #
+    # @return [String]
+    attr_accessor :destination
+
+    # Type of destination for the rule. Required if `direction` = `EGRESS`.
+    #
+    # 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).
+    #
+    #   * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID of a
+    #     {NetworkSecurityGroup}.
+    #
+    # @return [String]
+    attr_reader :destination_type
+
+    # **[Required]** Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, or `INGRESS` for rules to allow inbound IP packets.
+    # @return [String]
+    attr_reader :direction
+
+    # Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code
+    # as defined in:
+    # - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)
+    # - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)
+    #
+    # If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and
+    # codes are allowed. If you do provide this object, the type is required and the code is optional.
+    # To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination
+    # Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify
+    # multiple codes for a single type, create a separate security list rule for each.
+    #
+    # @return [OCI::Core::Models::IcmpOptions]
+    attr_accessor :icmp_options
+
+    # A stateless rule allows traffic in one direction. Remember to add a corresponding
+    # stateless rule in the other direction if you need to support bidirectional traffic. For
+    # example, if egress traffic allows TCP destination port 80, there should be an ingress
+    # rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
+    # and a corresponding rule is not necessary for bidirectional traffic.
+    #
+    # @return [BOOLEAN]
+    attr_accessor :is_stateless
+
+    # **[Required]** The transport protocol. Specify either `all` or an IPv4 protocol number as
+    # defined in
+    # [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
+    # Options are supported only for ICMP (\"1\"), TCP (\"6\"), UDP (\"17\"), and ICMPv6 (\"58\").
+    #
+    # @return [String]
+    attr_accessor :protocol
+
+    # Conceptually, this is the range of IP addresses that a packet coming into the instance
+    # can come from.
+    #
+    # Allowed values:
+    #
+    #   * An 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 rule for traffic coming from a particular `Service` through
+    #     a service gateway. For example: `oci-phx-objectstorage`.
+    #
+    #   * The OCID of a {NetworkSecurityGroup} in the same
+    #     VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
+    #     traffic between VNICs in the same NSG.
+    #
+    # @return [String]
+    attr_accessor :source
+
+    # Type of source for the rule. Required if `direction` = `INGRESS`.
+    #
+    #   * `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).
+    #
+    #   * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID of a
+    #     {NetworkSecurityGroup}.
+    #
+    # @return [String]
+    attr_reader :source_type
+
+    # Optional and valid only for TCP. Use to specify particular destination ports for TCP rules.
+    # If you specify TCP as the protocol but omit this object, then all destination ports are allowed.
+    #
+    # @return [OCI::Core::Models::TcpOptions]
+    attr_accessor :tcp_options
+
+    # Optional and valid only for UDP. Use to specify particular destination ports for UDP rules.
+    # If you specify UDP as the protocol but omit this object, then all destination ports are allowed.
+    #
+    # @return [OCI::Core::Models::UdpOptions]
+    attr_accessor :udp_options
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'description': :'description',
+        'destination': :'destination',
+        'destination_type': :'destinationType',
+        'direction': :'direction',
+        'icmp_options': :'icmpOptions',
+        'is_stateless': :'isStateless',
+        'protocol': :'protocol',
+        'source': :'source',
+        'source_type': :'sourceType',
+        'tcp_options': :'tcpOptions',
+        'udp_options': :'udpOptions'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'description': :'String',
+        'destination': :'String',
+        'destination_type': :'String',
+        'direction': :'String',
+        'icmp_options': :'OCI::Core::Models::IcmpOptions',
+        'is_stateless': :'BOOLEAN',
+        'protocol': :'String',
+        'source': :'String',
+        'source_type': :'String',
+        'tcp_options': :'OCI::Core::Models::TcpOptions',
+        'udp_options': :'OCI::Core::Models::UdpOptions'
+        # 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] :description The value to assign to the {#description} property
+    # @option attributes [String] :destination The value to assign to the {#destination} property
+    # @option attributes [String] :destination_type The value to assign to the {#destination_type} property
+    # @option attributes [String] :direction The value to assign to the {#direction} property
+    # @option attributes [OCI::Core::Models::IcmpOptions] :icmp_options The value to assign to the {#icmp_options} property
+    # @option attributes [BOOLEAN] :is_stateless The value to assign to the {#is_stateless} property
+    # @option attributes [String] :protocol The value to assign to the {#protocol} property
+    # @option attributes [String] :source The value to assign to the {#source} property
+    # @option attributes [String] :source_type The value to assign to the {#source_type} property
+    # @option attributes [OCI::Core::Models::TcpOptions] :tcp_options The value to assign to the {#tcp_options} property
+    # @option attributes [OCI::Core::Models::UdpOptions] :udp_options The value to assign to the {#udp_options} 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.description = attributes[:'description'] if attributes[:'description']
+
+      self.destination = attributes[:'destination'] if attributes[:'destination']
+
+      self.destination_type = attributes[:'destinationType'] if attributes[:'destinationType']
+
+      raise 'You cannot provide both :destinationType and :destination_type' if attributes.key?(:'destinationType') && attributes.key?(:'destination_type')
+
+      self.destination_type = attributes[:'destination_type'] if attributes[:'destination_type']
+
+      self.direction = attributes[:'direction'] if attributes[:'direction']
+
+      self.icmp_options = attributes[:'icmpOptions'] if attributes[:'icmpOptions']
+
+      raise 'You cannot provide both :icmpOptions and :icmp_options' if attributes.key?(:'icmpOptions') && attributes.key?(:'icmp_options')
+
+      self.icmp_options = attributes[:'icmp_options'] if attributes[:'icmp_options']
+
+      self.is_stateless = attributes[:'isStateless'] unless attributes[:'isStateless'].nil?
+
+      raise 'You cannot provide both :isStateless and :is_stateless' if attributes.key?(:'isStateless') && attributes.key?(:'is_stateless')
+
+      self.is_stateless = attributes[:'is_stateless'] unless attributes[:'is_stateless'].nil?
+
+      self.protocol = attributes[:'protocol'] if attributes[:'protocol']
+
+      self.source = attributes[:'source'] if attributes[:'source']
+
+      self.source_type = attributes[:'sourceType'] if attributes[:'sourceType']
+
+      raise 'You cannot provide both :sourceType and :source_type' if attributes.key?(:'sourceType') && attributes.key?(:'source_type')
+
+      self.source_type = attributes[:'source_type'] if attributes[:'source_type']
+
+      self.tcp_options = attributes[:'tcpOptions'] if attributes[:'tcpOptions']
+
+      raise 'You cannot provide both :tcpOptions and :tcp_options' if attributes.key?(:'tcpOptions') && attributes.key?(:'tcp_options')
+
+      self.tcp_options = attributes[:'tcp_options'] if attributes[:'tcp_options']
+
+      self.udp_options = attributes[:'udpOptions'] if attributes[:'udpOptions']
+
+      raise 'You cannot provide both :udpOptions and :udp_options' if attributes.key?(:'udpOptions') && attributes.key?(:'udp_options')
+
+      self.udp_options = attributes[:'udp_options'] if attributes[:'udp_options']
+    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] destination_type Object to be assigned
+    def destination_type=(destination_type)
+      raise "Invalid value for 'destination_type': this must be one of the values in DESTINATION_TYPE_ENUM." if destination_type && !DESTINATION_TYPE_ENUM.include?(destination_type)
+
+      @destination_type = destination_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] direction Object to be assigned
+    def direction=(direction)
+      raise "Invalid value for 'direction': this must be one of the values in DIRECTION_ENUM." if direction && !DIRECTION_ENUM.include?(direction)
+
+      @direction = direction
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source_type Object to be assigned
+    def source_type=(source_type)
+      raise "Invalid value for 'source_type': this must be one of the values in SOURCE_TYPE_ENUM." if source_type && !SOURCE_TYPE_ENUM.include?(source_type)
+
+      @source_type = source_type
+    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 &&
+        description == other.description &&
+        destination == other.destination &&
+        destination_type == other.destination_type &&
+        direction == other.direction &&
+        icmp_options == other.icmp_options &&
+        is_stateless == other.is_stateless &&
+        protocol == other.protocol &&
+        source == other.source &&
+        source_type == other.source_type &&
+        tcp_options == other.tcp_options &&
+        udp_options == other.udp_options
+    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
+      [description, destination, destination_type, direction, icmp_options, is_stateless, protocol, source, source_type, tcp_options, udp_options].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