oci 2.0.5 → 2.0.6

data/lib/oci/load_balancer/models/backend_set.rb

@@ -3,14 +3,20 @@
 require 'date'
 
 module OCI
+  # The configuration of a load balancer backend set.
+  # For more information on backend set configuration, see
+  # [Managing Backend Sets](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm).
+  #
   class LoadBalancer::Models::BackendSet
+    # This attribute is required.
     # @return [Array<OCI::LoadBalancer::Models::Backend>]
     attr_accessor :backends
 
+    # This attribute is required.
     # @return [OCI::LoadBalancer::Models::HealthChecker]
     attr_accessor :health_checker
 
-    # A friendly name for the backend set. It must be unique and it cannot be changed.
+    # **[Required]** A friendly name for the backend set. It must be unique and it cannot be changed.
     # 
     # Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot
     # contain spaces. Avoid entering confidential information.
@@ -20,7 +26,7 @@ module OCI
     # @return [String]
     attr_accessor :name
 
-    # The load balancer policy for the backend set. To get a list of available policies, use the
+    # **[Required]** The load balancer policy for the backend set. To get a list of available policies, use the
     # {#list_policies list_policies} operation.
     # 
     # Example: `LEAST_CONNECTIONS`
@@ -37,6 +43,12 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<OCI::LoadBalancer::Models::Backend>] :backends The value to assign to the {#backends} property
+    # @option attributes [OCI::LoadBalancer::Models::HealthChecker] :healthChecker The value to assign to the {#health_checker} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :policy The value to assign to the {#policy} property
+    # @option attributes [OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails] :sessionPersistenceConfiguration The value to assign to the {#session_persistence_configuration} property
+    # @option attributes [OCI::LoadBalancer::Models::SSLConfiguration] :sslConfiguration The value to assign to the {#ssl_configuration} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/backend_set_details.rb

@@ -3,14 +3,19 @@
 require 'date'
 
 module OCI
+  # The configuration details for a load balancer backend set.
+  # For more information on backend set configuration, see
+  # [Managing Backend Sets](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm).
+  #
   class LoadBalancer::Models::BackendSetDetails
     # @return [Array<OCI::LoadBalancer::Models::BackendDetails>]
     attr_accessor :backends
 
+    # This attribute is required.
     # @return [OCI::LoadBalancer::Models::HealthCheckerDetails]
     attr_accessor :health_checker
 
-    # The load balancer policy for the backend set. To get a list of available policies, use the
+    # **[Required]** The load balancer policy for the backend set. To get a list of available policies, use the
     # {#list_policies list_policies} operation.
     # 
     # Example: `LEAST_CONNECTIONS`
@@ -27,6 +32,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<OCI::LoadBalancer::Models::BackendDetails>] :backends The value to assign to the {#backends} property
+    # @option attributes [OCI::LoadBalancer::Models::HealthCheckerDetails] :healthChecker The value to assign to the {#health_checker} property
+    # @option attributes [String] :policy The value to assign to the {#policy} property
+    # @option attributes [OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails] :sessionPersistenceConfiguration The value to assign to the {#session_persistence_configuration} property
+    # @option attributes [OCI::LoadBalancer::Models::SSLConfigurationDetails] :sslConfiguration The value to assign to the {#ssl_configuration} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/backend_set_health.rb

@@ -3,6 +3,11 @@
 require 'date'
 
 module OCI
+  # The health status details for a backend set.
+  #
+  # This object does not explicitly enumerate backend servers with a status of `OK`. However, they are included in the
+  # `totalBackendCount` sum.
+  #
   class LoadBalancer::Models::BackendSetHealth
 
     STATUS_ENUM = [STATUS_OK = 'OK',
@@ -11,7 +16,7 @@ module OCI
                 STATUS_UNKNOWN = 'UNKNOWN',
                 STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by
+    # **[Required]** A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by
     # IP address and port.
     # 
     # Example: `1.1.1.1:80`
@@ -19,7 +24,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :critical_state_backend_names
 
-    # Overall health status of the backend set.
+    # **[Required]** Overall health status of the backend set.
     # 
     # *  **OK:** All backend servers in the backend set return a status of `OK`.
     # 
@@ -34,14 +39,14 @@ module OCI
     # @return [String]
     attr_accessor :status
 
-    # The total number of backend servers in this backend set.
+    # **[Required]** The total number of backend servers in this backend set.
     # 
     # Example: `5`
     # 
     # @return [Integer]
     attr_accessor :total_backend_count
 
-    # A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by
+    # **[Required]** A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by
     # IP address and port.
     # 
     # Example: `1.1.1.5:80`
@@ -49,7 +54,7 @@ module OCI
     # @return [Array<String>]
     attr_accessor :unknown_state_backend_names
 
-    # A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by
+    # **[Required]** A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by
     # IP address and port.
     # 
     # Example: `1.1.1.7:42`
@@ -60,6 +65,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<String>] :criticalStateBackendNames The value to assign to the {#critical_state_backend_names} property
+    # @option attributes [String] :status The value to assign to the {#status} property
+    # @option attributes [Integer] :totalBackendCount The value to assign to the {#total_backend_count} property
+    # @option attributes [Array<String>] :unknownStateBackendNames The value to assign to the {#unknown_state_backend_names} property
+    # @option attributes [Array<String>] :warningStateBackendNames The value to assign to the {#warning_state_backend_names} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/certificate.rb

@@ -3,8 +3,12 @@
 require 'date'
 
 module OCI
+  # The configuration details of a listener certificate bundle.
+  # For more information on SSL certficate configuration, see
+  # [Managing SSL Certificates](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingcertificates.htm).
+  #
   class LoadBalancer::Models::Certificate
-    # The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.
+    # **[Required]** The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.
     # 
     # Example:
     # 
@@ -19,7 +23,7 @@ module OCI
     # @return [String]
     attr_accessor :ca_certificate
 
-    # A friendly name for the certificate bundle. It must be unique and it cannot be changed.
+    # **[Required]** A friendly name for the certificate bundle. It must be unique and it cannot be changed.
     # Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
     # Certificate bundle names cannot contain spaces. Avoid entering confidential information.
     # 
@@ -28,7 +32,7 @@ module OCI
     # @return [String]
     attr_accessor :certificate_name
 
-    # The public certificate, in PEM format, that you received from your SSL certificate provider.
+    # **[Required]** The public certificate, in PEM format, that you received from your SSL certificate provider.
     # 
     # Example:
     # 
@@ -46,6 +50,9 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :caCertificate The value to assign to the {#ca_certificate} property
+    # @option attributes [String] :certificateName The value to assign to the {#certificate_name} property
+    # @option attributes [String] :publicCertificate The value to assign to the {#public_certificate} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/certificate_details.rb

@@ -3,6 +3,10 @@
 require 'date'
 
 module OCI
+  # The configuration details for a listener certificate bundle.
+  # For more information on SSL certficate configuration, see
+  # [Managing SSL Certificates](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingcertificates.htm).
+  #
   class LoadBalancer::Models::CertificateDetails
     # The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.
     # 
@@ -19,7 +23,7 @@ module OCI
     # @return [String]
     attr_accessor :ca_certificate
 
-    # A friendly name for the certificate bundle. It must be unique and it cannot be changed.
+    # **[Required]** A friendly name for the certificate bundle. It must be unique and it cannot be changed.
     # Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
     # Certificate bundle names cannot contain spaces. Avoid entering confidential information.
     # 
@@ -68,6 +72,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :caCertificate The value to assign to the {#ca_certificate} property
+    # @option attributes [String] :certificateName The value to assign to the {#certificate_name} property
+    # @option attributes [String] :passphrase The value to assign to the {#passphrase} property
+    # @option attributes [String] :privateKey The value to assign to the {#private_key} property
+    # @option attributes [String] :publicCertificate The value to assign to the {#public_certificate} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/load_balancer/models/connection_configuration.rb

@@ -0,0 +1,157 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  # Configuration details for the connection between the client and backend servers.
+  #
+  class LoadBalancer::Models::ConnectionConfiguration
+    # **[Required]** The maximum idle time, in seconds, allowed between two successive receive or two successive send operations
+    # between the client and backend servers. A send operation does not reset the timer for receive operations. A
+    # receive operation does not reset the timer for send operations.
+    # 
+    # The default values are:
+    # 
+    # *  300 seconds for TCP
+    # 
+    # *  60 seconds for HTTP and WebSocket protocols.
+    # 
+    # Note: The protocol is set at the listener.
+    # 
+    # Modify this parameter if the client or backend server stops transmitting data for more than the default time.
+    # Some examples include:
+    # 
+    # *  The client sends a database query to the backend server and the database takes over 300 seconds to execute.
+    #    Therefore, the backend server does not transmit any data within 300 seconds.
+    # 
+    # *  The client uploads data using the HTTP protocol. During the upload, the backend does not transmit any data
+    #    to the client for more than 60 seconds.
+    # 
+    # *  The client downloads data using the HTTP protocol.  After the initial request, it stops transmitting data to
+    #    the backend server for more than 60 seconds.
+    # 
+    # *  The client starts transmitting data after establishing a WebSocket connection, but the backend server does
+    #    not transmit data for more than 60 seconds.
+    # 
+    # *  The backend server starts transmitting data after establishing a WebSocket connection, but the client does
+    #    not transmit data for more than 60 seconds.
+    # 
+    # The maximum value is 7200 seconds. Contact My Oracle Support to file a service request if you want to increase
+    # this limit for your tenancy. For more information, see [Service Limits](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm).
+    # 
+    # Example: `1200`
+    # 
+    # @return [Integer]
+    attr_accessor :idle_timeout
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Integer] :idleTimeout The value to assign to the {#idle_timeout} 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}
+
+      if attributes[:'idleTimeout']
+        self.idle_timeout = attributes[:'idleTimeout']
+      end
+
+    end
+
+    # 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 &&
+          idle_timeout == other_object.idle_timeout
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [idle_timeout].hash
+    end
+
+    # 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)
+            self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($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
+      end
+
+      self
+    end
+
+    # 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
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'idle_timeout' => :'idleTimeout'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'idle_timeout' => :'Integer'
+      }
+    end
+  end
+end

data/lib/oci/load_balancer/models/create_backend_details.rb

@@ -3,6 +3,10 @@
 require 'date'
 
 module OCI
+  # The configuration details for creating a backend server in a backend set.
+  # For more information on backend server configuration, see
+  # [Managing Backend Servers](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendservers.htm).
+  #
   class LoadBalancer::Models::CreateBackendDetails
     # Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
     # traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy.
@@ -20,7 +24,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :drain
 
-    # The IP address of the backend server.
+    # **[Required]** The IP address of the backend server.
     # 
     # Example: `10.10.10.4`
     # 
@@ -35,7 +39,7 @@ module OCI
     # @return [BOOLEAN]
     attr_accessor :offline
 
-    # The communication port for the backend server.
+    # **[Required]** The communication port for the backend server.
     # 
     # Example: `8080`
     # 
@@ -56,19 +60,25 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [BOOLEAN] :backup The value to assign to the {#backup} property
+    # @option attributes [BOOLEAN] :drain The value to assign to the {#drain} property
+    # @option attributes [String] :ipAddress The value to assign to the {#ip_address} property
+    # @option attributes [BOOLEAN] :offline The value to assign to the {#offline} property
+    # @option attributes [Integer] :port The value to assign to the {#port} property
+    # @option attributes [Integer] :weight The value to assign to the {#weight} 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}
 
-      if attributes[:'backup']
+      unless attributes[:'backup'].nil?
         self.backup = attributes[:'backup']
       else
         self.backup = false
       end
 
-      if attributes[:'drain']
+      unless attributes[:'drain'].nil?
         self.drain = attributes[:'drain']
       else
         self.drain = false
@@ -78,7 +88,7 @@ module OCI
         self.ip_address = attributes[:'ipAddress']
       end
 
-      if attributes[:'offline']
+      unless attributes[:'offline'].nil?
         self.offline = attributes[:'offline']
       else
         self.offline = false

data/lib/oci/load_balancer/models/create_backend_set_details.rb

@@ -3,14 +3,19 @@
 require 'date'
 
 module OCI
+  # The configuration details for creating a backend set in a load balancer.
+  # For more information on backend set configuration, see
+  # [Managing Backend Sets](https://docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendsets.htm).
+  #
   class LoadBalancer::Models::CreateBackendSetDetails
     # @return [Array<OCI::LoadBalancer::Models::BackendDetails>]
     attr_accessor :backends
 
+    # This attribute is required.
     # @return [OCI::LoadBalancer::Models::HealthCheckerDetails]
     attr_accessor :health_checker
 
-    # A friendly name for the backend set. It must be unique and it cannot be changed.
+    # **[Required]** A friendly name for the backend set. It must be unique and it cannot be changed.
     # 
     # Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot
     # contain spaces. Avoid entering confidential information.
@@ -20,7 +25,7 @@ module OCI
     # @return [String]
     attr_accessor :name
 
-    # The load balancer policy for the backend set. To get a list of available policies, use the
+    # **[Required]** The load balancer policy for the backend set. To get a list of available policies, use the
     # {#list_policies list_policies} operation.
     # 
     # Example: `LEAST_CONNECTIONS`
@@ -37,6 +42,12 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [Array<OCI::LoadBalancer::Models::BackendDetails>] :backends The value to assign to the {#backends} property
+    # @option attributes [OCI::LoadBalancer::Models::HealthCheckerDetails] :healthChecker The value to assign to the {#health_checker} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :policy The value to assign to the {#policy} property
+    # @option attributes [OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails] :sessionPersistenceConfiguration The value to assign to the {#session_persistence_configuration} property
+    # @option attributes [OCI::LoadBalancer::Models::SSLConfigurationDetails] :sslConfiguration The value to assign to the {#ssl_configuration} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)